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

consider numpydoc formatting for docstrings #5

Open
slivingston opened this issue Apr 28, 2019 · 0 comments
Open

consider numpydoc formatting for docstrings #5

slivingston opened this issue Apr 28, 2019 · 0 comments
Assignees
@slivingston
Labels
documentation

Comments

@slivingston
Copy link
Member

This API might be easier to understand if it has the standard formatting of the numpy API documentation. As part of this issue, if we are not going to follow numpy doc style, then recommend another.

References

  1. https://numpydoc.readthedocs.io/en/latest/format.html
  2. https://numpydoc.readthedocs.io/en/latest/example.html
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@slivingston slivingston

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@slivingston