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.

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

Improve documentation of optional arguments to callables #270

Open
davidorme opened this issue Aug 8, 2024 · 0 comments
Open

Improve documentation of optional arguments to callables #270

davidorme opened this issue Aug 8, 2024 · 0 comments

Comments

@davidorme
Copy link
Collaborator

Is your feature request related to a problem? Please describe.

As @j-emberton pointed out over on #267, the docstrings don't do a consistent job of making it clear where arguments are optional and what happens when they aren't provided. It's clear which arguments are optional from the typing, but then individual argument descriptions should consistently end with something like "Optional, defaulting to XYZ".

Describe the solution you'd like
Review the signatures and consistently note the optional arguments in the Args section of the docstrings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Priorities and low hanging fruit
Development

No branches or pull requests

1 participant