Add more help to "template" flags #6296
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
cliAutomation
added
the
external
samcoe
approved these changes
Sep 19, 2022
mislav
reviewed
Sep 19, 2022
| @@ -219,7 +219,7 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command | |||
| cmd.Flags().BoolVar(&opts.Paginate, "paginate", false, "Make additional HTTP requests to fetch all pages of results") | |||
| cmd.Flags().StringVar(&opts.RequestInputFile, "input", "", "The `file` to use as body for the HTTP request (use \"-\" to read from standard input)") | |||
| cmd.Flags().BoolVar(&opts.Silent, "silent", false, "Do not print the response body") | |||
| cmd.Flags().StringVarP(&opts.Template, "template", "t", "", "Format the response using a Go template") | |||
| cmd.Flags().StringVarP(&opts.Template, "template", "t", "", "Format JSON output using a Go template; see \"gh help formatting\"") | |||
There was a problem hiding this comment.
This line of docs gets automatically added to any command that has a --template flag:
For more information about output formatting flags, see `gh help formatting`.
Do you think it's also worth pointing this out in the description of the flag itself?
There was a problem hiding this comment.
Personally, not much. But see the linked bug for the discussion that lead to this PR.
vilmibm
approved these changes
Oct 4, 2022
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.
Resolves #6089