Skip to content

Commit

Permalink
doc: Ad help flag and cmd when generating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
n10v committed May 20, 2017
1 parent 52ae6a1 commit ca57f0f
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/man_docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,9 @@ func manPrintOptions(buf *bytes.Buffer, command *cobra.Command) {
}

func genMan(cmd *cobra.Command, header *GenManHeader) []byte {
cmd.InitDefaultHelpCmd()
cmd.InitDefaultHelpFlag()

// something like `rootcmd-subcmd1-subcmd2`
dashCommandName := strings.Replace(cmd.CommandPath(), " ", "-", -1)

Expand Down
3 changes: 3 additions & 0 deletions doc/md_docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ func GenMarkdown(cmd *cobra.Command, w io.Writer) error {

// GenMarkdownCustom creates custom markdown output.
func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error {
cmd.InitDefaultHelpCmd()
cmd.InitDefaultHelpFlag()

buf := new(bytes.Buffer)
name := cmd.CommandPath()

Expand Down
3 changes: 3 additions & 0 deletions doc/yaml_docs.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@ func GenYaml(cmd *cobra.Command, w io.Writer) error {

// GenYamlCustom creates custom yaml output.
func GenYamlCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error {
cmd.InitDefaultHelpCmd()
cmd.InitDefaultHelpFlag()

yamlDoc := cmdDoc{}
yamlDoc.Name = cmd.CommandPath()

Expand Down

0 comments on commit ca57f0f

Please sign in to comment.