-
Notifications
You must be signed in to change notification settings - Fork 57
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 arguments #22
Comments
@cdeil The best way to approach this is with a PR. I'm pretty sure I borrowed the layout from click-contrib's brethren, sphinxcontrib-autoprogram. Ideally, I'd like to make this configurable. Perhaps a |
Just checking if there has been any progress on this issue. Is this happening? |
No. As noted above, we'd need a PR to work on this |
Currently you document command like this (see here):
Click in the console help output documents commands like this
Click docs at http://click.pocoo.org/dev/arguments/ say
and expects arguments to be documented in the help text. Given that arguments don't support a help the argument docs you are generating doesn't really contain much useful information.
How about removing arguments docs completely, i.e. follow the lead of click for the help page?
Or if you want to keep it: how about putting the argument description before the options, i.e. closer to where arguments are usually described for click commands, and add a config option for
click-sphinx
users to select if they want to emit the arguments rubric (for me it would be no, I would like to not have it)?A more minor question / change request I have is whether it would be better to put the command help text after the usage line. This is then how click and man pages in general do it, and what I find most readable to have the usage line at the top.
@stephenfin - Let me know what you think. If you agree with any of the suggestions I'd be happy to make a pull request.
The text was updated successfully, but these errors were encountered: