fix inconsistencies in md generation

spf13 · Oct 11, 2023 · 5d16684 · 5d16684
1 parent 95d8a1e
commit 5d16684
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/doc/md_docs.go b/doc/md_docs.go
@@ -31,15 +31,15 @@ func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error {
 	flags := cmd.NonInheritedFlags()
 	flags.SetOutput(buf)
 	if flags.HasAvailableFlags() {
-		buf.WriteString("### Options\n\n```\n")
+		buf.WriteString("### Flags\n\n```\n")
 		flags.PrintDefaults()
 		buf.WriteString("```\n\n")
 	}
 
 	parentFlags := cmd.InheritedFlags()
 	parentFlags.SetOutput(buf)
 	if parentFlags.HasAvailableFlags() {
-		buf.WriteString("### Options inherited from parent commands\n\n```\n")
+		buf.WriteString("### Flags inherited from parent commands\n\n```\n")
 		parentFlags.PrintDefaults()
 		buf.WriteString("```\n\n")
 	}

diff --git a/doc/md_docs_test.go b/doc/md_docs_test.go
@@ -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, "Options inherited from parent commands")
+	checkStringContains(t, output, "Flags inherited from parent commands")
 }
 
 func TestGenMdDocWithNoLongOrSynopsis(t *testing.T) {
@@ -52,7 +52,7 @@ func TestGenMdDocWithNoLongOrSynopsis(t *testing.T) {
 
 	checkStringContains(t, output, dummyCmd.Example)
 	checkStringContains(t, output, dummyCmd.Short)
-	checkStringContains(t, output, "Options inherited from parent commands")
+	checkStringContains(t, output, "Flags inherited from parent commands")
 	checkStringOmits(t, output, "### Synopsis")
 }
 
@@ -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, "Options inherited from parent commands")
+	checkStringOmits(t, output, "Flags inherited from parent commands")
 }
 
 func TestGenMdNoTag(t *testing.T) {