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

Examples in docstring #64

Open
jonlym opened this issue May 24, 2019 · 0 comments
Open

Examples in docstring #64

jonlym opened this issue May 24, 2019 · 0 comments
Labels
enhancement New feature or request

Comments

@jonlym
Copy link
Member

jonlym commented May 24, 2019

The docstrings should show examples of the functions. See the documentation of Numpy for examples.

Also, we should add an examples module for ready-made objects (like Nasa, Reaction, etc.) to reduce the setup code.
@jonlym jonlym added the enhancement New feature or request label May 24, 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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jonlym