From 73e1b0f379682035609a9e9a2010f7f16b63a0e8 Mon Sep 17 00:00:00 2001 From: Yik San Chan Date: Tue, 8 Feb 2022 03:34:03 +0000 Subject: [PATCH] Remove unneeded error from printOption method The code below doesn't really need the `error` as return type, so I remove it ```go func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error { flags := cmd.NonInheritedFlags() flags.SetOutput(buf) if flags.HasAvailableFlags() { parentFlags.PrintDefaults() buf.WriteString("```\n\n") } return nil } ``` Merge https://github.com/spf13/cobra/pull/1549 --- doc/md_docs.go | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/doc/md_docs.go b/doc/md_docs.go index 5181af8..9df609e 100644 --- a/doc/md_docs.go +++ b/doc/md_docs.go @@ -26,7 +26,7 @@ import ( "github.com/spf13/cobra" ) -func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error { +func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) { flags := cmd.NonInheritedFlags() flags.SetOutput(buf) if flags.HasAvailableFlags() { @@ -42,7 +42,6 @@ func printOptions(buf *bytes.Buffer, cmd *cobra.Command, name string) error { parentFlags.PrintDefaults() buf.WriteString("```\n\n") } - return nil } // GenMarkdown creates markdown output. @@ -74,9 +73,8 @@ func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) buf.WriteString(fmt.Sprintf("```\n%s\n```\n\n", cmd.Example)) } - if err := printOptions(buf, cmd, name); err != nil { - return err - } + printOptions(buf, cmd, name) + if hasSeeAlso(cmd) { buf.WriteString("### SEE ALSO\n\n") if cmd.HasParent() {