Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move to NumPy style docstrings? #133

Open
ziw-liu opened this issue Aug 13, 2024 · 1 comment
Open

Move to NumPy style docstrings? #133

ziw-liu opened this issue Aug 13, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation maintenance Maintenance work
Milestone
v0.4.0

Comments

@ziw-liu
Copy link
Collaborator

ziw-liu commented Aug 13, 2024

This package inherited single-line sphinx style docstrings from microDL. However this is different from the NumPy style that most of our contributors are used to and sometimes IDE settings get mixed up. Maybe moving to NumPy style will reduce some friction?
@ziw-liu ziw-liu added documentation Improvements or additions to documentation maintenance Maintenance work labels Aug 13, 2024
@mattersoflight
Copy link
Member

Good suggestion - I think we should switch over to NumPy style docstrings for the sake of readability of docstrings.

@ziw-liu ziw-liu added this to the v0.4.0 milestone Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation maintenance Maintenance work
Projects
None yet
Milestone
v0.4.0
Development

No branches or pull requests
2 participants
@mattersoflight @ziw-liu