fix: correct command path in see_also for YAML doc #1771
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
The `see_also` section for child commands would include only the name of command. This adds the whole path, similar to how it's done for the other documentation formats.
|
|
github-actions
bot
added
area/docs-generation
marckhouzam
approved these changes
Aug 13, 2022
There was a problem hiding this comment.
That's much better, thanks @zregvart! (and thanks @stmcginnis for having a look)
I have tested it with helm and if we take the helm repo command and generate the yaml tree, the generated yaml before this PR would end with:
see_also:
- helm - The Helm package manager for Kubernetes.
- add - add a chart repository
- index - generate an index file given a directory containing packaged charts
- list - list chart repositories
- remove - remove one or more chart repositories
- update - update information of available charts locally from chart repositories
but now:
see_also:
- helm - The Helm package manager for Kubernetes.
- helm repo add - add a chart repository
- helm repo index - generate an index file given a directory containing packaged charts
- helm repo list - list chart repositories
- helm repo remove - remove one or more chart repositories
- helm repo update - update information of available charts locally from chart repositories
It is not only much clearer but it does match what we output for markdown and man docs.
|
Thanks @stmcginnis and @marckhouzam! |
Closed
jimschubert
added a commit
to jimschubert/cobra
that referenced
this pull request
Oct 3, 2022
* main: (39 commits) Add '--version' flag to Help output (spf13#1707) Expose ValidateRequiredFlags and ValidateFlagGroups (spf13#1760) Document option to hide the default completion cmd (spf13#1779) ci: add workflow_dispatch (spf13#1387) add missing license headers (spf13#1809) ci: use action/setup-go's cache (spf13#1783) Adjustments to documentation (spf13#1656) Rename Powershell completion tests (spf13#1803) Support for case-insensitive command names (spf13#1802) Deprecate ExactValidArgs() and test combinations of args validators (spf13#1643) Use correct stale action `exempt-` yaml keys (spf13#1800) With go 1.18, we must use go install for a binary (spf13#1726) Clarify SetContext documentation (spf13#1748) ci: test on Golang 1.19 (spf13#1782) fix: show flags that shadow parent persistent flag in child help (spf13#1776) Update gopkg.in/yaml.v2 to gopkg.in/yaml.v3 (spf13#1766) fix(bash-v2): activeHelp length check syntax (spf13#1762) fix: correct command path in see_also for YAML doc (spf13#1771) build(deps): bump github.com/inconshreveable/mousetrap (spf13#1774) docs: add zitadel to the list (spf13#1772) ...
hoshsadiq
pushed a commit
to zulucmd/zulu
that referenced
this pull request
Dec 31, 2022
The `see_also` section for child commands would include only the name of command. This adds the whole path, similar to how it's done for the other documentation formats. Merge spf13/cobra#1771
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.
The
see_alsosection for child commands would include only the name of command. This adds the whole path, similar to how it's done for the other documentation formats.