From 7790bf97fd40e285913066cf65387ad281cd6c2e Mon Sep 17 00:00:00 2001 From: Zoran Regvart Date: Sat, 13 Aug 2022 23:31:45 +0200 Subject: [PATCH] fix: correct command path in see_also for YAML doc (#1771) The `see_also` section for child commands would include only the name of the commands. This adds the whole path, similar to how it's done for the other documentation formats. --- doc/yaml_docs.go | 2 +- doc/yaml_docs_test.go | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/yaml_docs.go b/doc/yaml_docs.go index a79fa40e..3069b4ee 100644 --- a/doc/yaml_docs.go +++ b/doc/yaml_docs.go @@ -128,7 +128,7 @@ func GenYamlCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) str if !child.IsAvailableCommand() || child.IsAdditionalHelpTopicCommand() { continue } - result = append(result, child.Name()+" - "+child.Short) + result = append(result, child.CommandPath()+" - "+child.Short) } yamlDoc.SeeAlso = result } diff --git a/doc/yaml_docs_test.go b/doc/yaml_docs_test.go index d08fa4f8..9bf5aa6c 100644 --- a/doc/yaml_docs_test.go +++ b/doc/yaml_docs_test.go @@ -2,6 +2,7 @@ package doc import ( "bytes" + "fmt" "io/ioutil" "os" "path/filepath" @@ -24,6 +25,7 @@ func TestGenYamlDoc(t *testing.T) { checkStringContains(t, output, "rootflag") checkStringContains(t, output, rootCmd.Short) checkStringContains(t, output, echoSubCmd.Short) + checkStringContains(t, output, fmt.Sprintf("- %s - %s", echoSubCmd.CommandPath(), echoSubCmd.Short)) } func TestGenYamlNoTag(t *testing.T) {