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

docstrings in examples and tests #20

Open
nmounet opened this issue Nov 15, 2024 · 0 comments
Open

docstrings in examples and tests #20

nmounet opened this issue Nov 15, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@nmounet
Copy link
Collaborator

nmounet commented Nov 15, 2024 •
edited
Loading

Examples are still a bit "dry" - they would benefit a lot from a short docstring (at their beginning) to explain in a few words what they are computing / benchmarking.
Same for tests: a minimal docstring for each would be nice.
@nmounet nmounet added the documentation Improvements or additions to documentation label Nov 15, 2024
@nmounet nmounet changed the title docstrings in examples docstrings in examples and tests Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nmounet