search

mkdocs / mkdocs-click

An MkDocs extension to generate documentation for Click command line applications
https://pypi.org/project/mkdocs-click
Apache License 2.0
109 stars 15 forks source link

`--help` should be kept in output instead of hard-dropping it #26

Closed florimondmanca closed 3 years ago

florimondmanca commented 3 years ago

Prompted by discussion in https://github.com/DataDog/mkdocs-click/pull/25#discussion_r542441592

Currently we drop the --help option from the output of command reference:

https://github.com/DataDog/mkdocs-click/blob/b7dc329dec1bf77dca6999e5c7c1b2b8c30610b1/mkdocs_click/_docs.py#L108-L111

We should probably keep it in for explicitness and simplicity. (Users may have renamed it to something else, readers might think it's actually not present, etc.)