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

Follow docstring conventions #6

Open
wimmers opened this issue Jun 13, 2019 · 0 comments
Open

Follow docstring conventions #6

wimmers opened this issue Jun 13, 2019 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@wimmers
Copy link
Collaborator

wimmers commented Jun 13, 2019

We should use proper Python docstrings following one of the conventions,
e.g. in
https://numpydoc.readthedocs.io/en/latest/format.html
or https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html.
@wimmers wimmers added enhancement New feature or request help wanted Extra attention is needed labels Jun 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wimmers