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.

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

Add documentation for flags with custom variable names #403

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

calebstewart
Copy link

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 UnquoteUsage function, and is referred to in FlagSet.FlagUsagesWrapped as the varname, so I used the term "flag variable name" here in the documentation.

I plan to open a separate PR over on spf13/cobra.dev to 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.

@CLAassistant
Copy link

CLAassistant commented May 8, 2024

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants