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

Add examples to docstrings #692

Open

nicholasloveday opened this issue Sep 13, 2024 · 1 comment

Labels

documentation good first issue

Collaborator

nicholasloveday commented Sep 13, 2024

Many of the docstrings don't have examples, we should aim to add examples to as many functions as possible

nicholasloveday added documentation good first issue labels

nicholasloveday mentioned this issue

(ready for review) Draft docstring template #690

Open

Collaborator

tennlee commented Nov 22, 2024

For anyone who would like to work on this:

Feel free to pick any docstring(s) that needs an example.
If you add examples to more than one docstring, please either raise a new PR for each docstring, or only include a few docstrings in each PR.
If you would like to, please feel free to do an audit to work out which docstrings still need examples. Please list the audit results in this issue.

tennlee changed the title ~~Add examples in all docstrings~~ Add examples to docstrings

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment