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

Documentation of decorators should should show where to look for arguments' reference #2280

Open
MrMino opened this issue May 8, 2022 · 0 comments · Fixed by #2281
Open
Labels

Comments

@MrMino
Copy link
Contributor

MrMino commented May 8, 2022

I've just started exploring click, and wholeheartedly love it. Thanks!

One thing that made the experience a bit frustrating was the API reference. Currently, in some places, it omits descriptions of the arguments of some of the decorators. For example, with click.argument, it just says the type is Any without telling where to look for the actual description:

image

I guess it's because the underlying argument class is customizable, but for the default usecase it would be nice to have a reference to the default.

Clicking on the reference to click.Argument doesn't reveal much either:

image

It would be nice if the description of attrs pointed to their actual reference: click.Parameter in case of argument and option decorators.

There's already a precedent for this in the docs - click.Group:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants