Add documentation for flags with custom variable names #403
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
|
|
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.
This PR adds documentation around the special back-tick syntax in flag usage to override the variable name displayed in the help output. This functionality is implemented in the
UnquoteUsagefunction, and is referred to inFlagSet.FlagUsagesWrappedas thevarname, so I used the term "flag variable name" here in the documentation.I plan to open a separate PR over on
spf13/cobra.devto address the higher-level Cobra documentation, since that is more likely to be seen by downstream users, but it deserves to be included here as well.This relates to spf13/cobra#2125, but I wouldn't consider that closed until this is added to the cobra documentation as well.