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

Extend Code Samples #17

Open
snototter opened this issue Oct 6, 2022 · 0 comments
Open

Extend Code Samples #17

snototter opened this issue Oct 6, 2022 · 0 comments
Assignees
@snototter
Labels
documentation Improvements or additions to documentation

Comments

@snototter
Copy link
Owner

All code samples (included in the docstrings) should explicitly include all (including optional) parameters.
The idea is to have samples which are copy-pastable and it's easier to remove parameters than to look them up separately in the API documentation.
@snototter snototter self-assigned this Oct 6, 2022
@snototter snototter added the documentation Improvements or additions to documentation label Oct 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@snototter snototter

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@snototter