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

Make template/set of best practices for writing docstrings #37

Open
hgscott opened this issue Aug 18, 2023 · 0 comments
Open

Make template/set of best practices for writing docstrings #37

hgscott opened this issue Aug 18, 2023 · 0 comments
Assignees
@hgscott

Comments

@hgscott
Copy link
Member

hgscott commented Aug 18, 2023

As posted by @hgscott in #30 (comment): It would be nice to have a template/set of best practices for writing the docstrings to get the best documentation.

We will want to do numpy style docstrings.
@hgscott hgscott self-assigned this Aug 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hgscott hgscott

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@hgscott