Take hidden attribute into account #38
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
thaJeztah
reviewed
Jun 27, 2023
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
crazy-max
force-pushed
the
missing-hidden
branch
from
736c6db to
530bde3
Compare
Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
crazy-max
force-pushed
the
missing-hidden
branch
from
530bde3 to
851d1b7
Compare
crazy-max
commented
Jun 27, 2023
| @@ -208,6 +214,9 @@ func mdCmdOutput(cmd *cobra.Command, old string) (string, error) { | |||
| b.WriteString("### Subcommands\n\n") | |||
| table := newMdTable("Name", "Description") | |||
| for _, c := range cmd.Commands() { | |||
| if c.Hidden { | |||
| continue | |||
There was a problem hiding this comment.
Don't think we need to log here, we already print log above for the command being skipped.
|
One other option would be to “warn” if no markdown file exists, but don’t create one if it’s not there. That way a project could decide to generate markdown for hidden commands by creating a .md for it, or to skip if by not creating one |
This was referenced Jun 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
follow-up #37 (comment)
Set
hiddenattribute for commands in YAML generation so it can be used on docs website. For markdown do not generate docs for hidden commands.