Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upConvert docstrings to numpydoc #1411
Open
Labels
Milestone
Comments
|
So far, the approach has been: def some_method(self, arg1, arg2):
"""The one-line description of the method.
Args:
arg1: Description
arg2: Description
Returns:
What this returns (if anything)
"""
# Begin implementation
return somethingI am open to new suggestions as long as we are standardized. |
|
Looks like numpydoc has a standard extension in sphinx, which will make the cross-reference easier. |
|
numpydoc is a good testable standard. Let's go with that. We can install
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment


Is your feature request related to a problem? Please describe.
Since in the near future a large number of new people will begin to work on the project, it is necessary to agree on a standard for docstrings. And introduce some kind of automatic checks.
For my part, I would like to suggest
nympydocpackage that we can use in github actions CI.