glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-11-24 14:47:12 +00:00
Code Issues Projects Releases Packages Wiki Activity

doc: Ad help flag and cmd when generating docs

Browse source
This commit is contained in:
Albert Nigmatzianov 2017-05-20 19:28:06 +02:00
parent 52ae6a1d02
commit ca57f0f5db
3 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/man_docs.go
View file

@ -190,6 +190,9 @@ func manPrintOptions(buf *bytes.Buffer, command *cobra.Command) {
} }
func genMan(cmd *cobra.Command, header *GenManHeader) []byte { func genMan(cmd *cobra.Command, header *GenManHeader) []byte {
cmd.InitDefaultHelpCmd()
cmd.InitDefaultHelpFlag()
// something like `rootcmd-subcmd1-subcmd2` // something like `rootcmd-subcmd1-subcmd2`
dashCommandName := strings.Replace(cmd.CommandPath(), " ", "-", -1) dashCommandName := strings.Replace(cmd.CommandPath(), " ", "-", -1)

3
doc/md_docs.go
View file

@ -52,6 +52,9 @@ func GenMarkdown(cmd *cobra.Command, w io.Writer) error {
// GenMarkdownCustom creates custom markdown output. // GenMarkdownCustom creates custom markdown output.
func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error { func GenMarkdownCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error {
cmd.InitDefaultHelpCmd()
cmd.InitDefaultHelpFlag()
buf := new(bytes.Buffer) buf := new(bytes.Buffer)
name := cmd.CommandPath() name := cmd.CommandPath()

3
doc/yaml_docs.go
View file

@ -89,6 +89,9 @@ func GenYaml(cmd *cobra.Command, w io.Writer) error {
// GenYamlCustom creates custom yaml output. // GenYamlCustom creates custom yaml output.
func GenYamlCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error { func GenYamlCustom(cmd *cobra.Command, w io.Writer, linkHandler func(string) string) error {
cmd.InitDefaultHelpCmd()
cmd.InitDefaultHelpFlag()
yamlDoc := cmdDoc{} yamlDoc := cmdDoc{}
yamlDoc.Name = cmd.CommandPath() yamlDoc.Name = cmd.CommandPath()