From 5d16684e884a90a490de82abda45720cc1f74a4a Mon Sep 17 00:00:00 2001 From: Lars Kajes Date: Wed, 11 Oct 2023 14:40:55 +0200 Subject: [PATCH] fix inconsistencies in md generation --- doc/md_docs.go | 4 ++-- doc/md_docs_test.go | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/md_docs.go b/doc/md_docs.go index c4a27c00..ba9de3ff 100644 --- a/doc/md_docs.go +++ b/doc/md_docs.go @@ -31,7 +31,7 @@ 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") } @@ -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("### 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 index e70cad82..4cdf95d1 100644 --- 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) {