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

Automatically draw client param descriptions from a pre-defined source #440

Open
voetberg opened this issue Dec 19, 2024 · 0 comments
Open
Labels
user User documentation

Comments

@voetberg
Copy link
Contributor

[Brought up in the 12/19/24 release retrospective] There is a good deal of inconsistency in parameter descriptions (between cli, different py client functions/modules). It would minimize work and improve the UX if kwargs were automatically paired with their descriptions where applicable.

Something like griffe could probably be used for to help with this, and it is already being used to generate py client documentation.

@voetberg voetberg added the user User documentation label Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
user User documentation
Projects
None yet
Development

No branches or pull requests

1 participant