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.

Sign up for GitHub

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

Jump to bottom

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

Closed
florimondmanca opened this issue Dec 16, 2020 · 0 comments · Fixed by #29
Closed

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

florimondmanca opened this issue Dec 16, 2020 · 0 comments · Fixed by #29
Labels
good first issue Good for newcomers rendering

Comments

@florimondmanca
Copy link
Contributor

florimondmanca commented Dec 16, 2020 •
edited
Loading

Prompted by discussion in #25 (comment)

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.)
@florimondmanca florimondmanca changed the title Keep --help in output instead of hard-dropping it --help should be kept in output instead of hard-dropping it Dec 16, 2020
@florimondmanca florimondmanca mentioned this issue Dec 16, 2020
Merged
@florimondmanca florimondmanca mentioned this issue Feb 17, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers rendering
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Keep --help as part of options raw output mkdocs/mkdocs-click
1 participant
@florimondmanca