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

Generated documentation includes hidden flags for commands #1663

Open
kevinbarbour opened this issue Apr 12, 2022 · 2 comments · May be fixed by #1664
Open

Generated documentation includes hidden flags for commands #1663

kevinbarbour opened this issue Apr 12, 2022 · 2 comments · May be fixed by #1664
Labels
area/docs-generation Generation of docs via Cobra kind/bug A bug in cobra; unintended behavior lifecycle/frozen Prevents GitHub actions from labeling issues / PRs with stale and rotten

Comments

@kevinbarbour
Copy link

I am trying to generate documentation for a CLI tool that has deprecated (and hidden) command flags, and I believe the generated documentation should not contain these flags unless they are specifically set to not be hidden after being deprecated. This is the behaviour that the generation follows for hidden commands, but not hidden flags on a non-hidden command.
@kevinbarbour kevinbarbour linked a pull request Apr 12, 2022 that will close this issue
Open
@johnSchnake
Copy link
Collaborator

Related #1272

@johnSchnake johnSchnake added kind/bug A bug in cobra; unintended behavior area/docs-generation Generation of docs via Cobra labels Apr 15, 2022
@github-actions
Copy link

The Cobra project currently lacks enough contributors to adequately respond to all issues. This bot triages issues and PRs according to the following rules:

  • After 60d of inactivity, lifecycle/stale is applied. - After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied and the issue is closed.
    You can:
  • Make a comment to remove the stale label and show your support. The 60 days reset. - If an issue has lifecycle/rotten and is closed, comment and ask maintainers if they'd be interseted in reopening

@jpmcb jpmcb reopened this Sep 8, 2022
@jpmcb jpmcb added lifecycle/frozen Prevents GitHub actions from labeling issues / PRs with stale and rotten and removed lifecycle/stale labels Sep 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/docs-generation Generation of docs via Cobra kind/bug A bug in cobra; unintended behavior lifecycle/frozen Prevents GitHub actions from labeling issues / PRs with stale and rotten
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Do not generate docs for hidden flags kevinbarbour/cobra
3 participants
@kevinbarbour @johnSchnake @jpmcb