Skip to content

Commit

Permalink
Revert back to 'Global Flags'
Browse files Browse the repository at this point in the history
  • Loading branch information
kajes committed Nov 6, 2023
1 parent 44242f9 commit b28f232
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion command.go
Original file line number Diff line number Diff line change
Expand Up @@ -568,7 +568,7 @@ Additional Commands:{{range $cmds}}{{if (and (eq .GroupID "") (or .IsAvailableCo
Flags:
{{.LocalFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasAvailableInheritedFlags}}
Flags inherited from parent commands:
Global Flags:
{{.InheritedFlags.FlagUsages | trimTrailingWhitespaces}}{{end}}{{if .HasHelpSubCommands}}
Additional help topics:{{range .Commands}}{{if .IsAdditionalHelpTopicCommand}}
Expand Down
2 changes: 1 addition & 1 deletion command_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -921,7 +921,7 @@ Flags:
--foo child foo usage
-h, --help help for child
Flags inherited from parent commands:
Global Flags:
--bar parent bar usage
`

Expand Down
2 changes: 1 addition & 1 deletion doc/md_docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error {
parentFlags := cmd.InheritedFlags()
parentFlags.SetOutput(buf)
if parentFlags.HasAvailableFlags() {
buf.WriteString("### Flags inherited from parent commands\n\n```\n")
buf.WriteString("### Global Flags\n\n```\n")
parentFlags.PrintDefaults()
buf.WriteString("```\n\n")
}
Expand Down
6 changes: 3 additions & 3 deletions doc/md_docs_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func TestGenMdDoc(t *testing.T) {
checkStringContains(t, output, rootCmd.Short)
checkStringContains(t, output, echoSubCmd.Short)
checkStringOmits(t, output, deprecatedCmd.Short)
checkStringContains(t, output, "Flags inherited from parent commands")
checkStringContains(t, output, "Global Flags")
}

func TestGenMdDocWithNoLongOrSynopsis(t *testing.T) {
Expand All @@ -52,7 +52,7 @@ func TestGenMdDocWithNoLongOrSynopsis(t *testing.T) {

checkStringContains(t, output, dummyCmd.Example)
checkStringContains(t, output, dummyCmd.Short)
checkStringContains(t, output, "Flags inherited from parent commands")
checkStringContains(t, output, "Global Flags")
checkStringOmits(t, output, "### Synopsis")
}

Expand All @@ -76,7 +76,7 @@ func TestGenMdNoHiddenParents(t *testing.T) {
checkStringContains(t, output, rootCmd.Short)
checkStringContains(t, output, echoSubCmd.Short)
checkStringOmits(t, output, deprecatedCmd.Short)
checkStringOmits(t, output, "Flags inherited from parent commands")
checkStringOmits(t, output, "Global Flags")
}

func TestGenMdNoTag(t *testing.T) {
Expand Down

0 comments on commit b28f232

Please sign in to comment.