mirror of
https://github.com/spf13/cobra
synced 2024-11-04 21:07:19 +00:00
bf11ab6321
Corrected the function name at the start of doc strings, as per the convention outlined in official go documentation: https://go.dev/blog/godoc |
||
---|---|---|
.. | ||
cmd_test.go | ||
man_docs.go | ||
man_docs.md | ||
man_docs_test.go | ||
man_examples_test.go | ||
md_docs.go | ||
md_docs.md | ||
md_docs_test.go | ||
README.md | ||
rest_docs.go | ||
rest_docs.md | ||
rest_docs_test.go | ||
util.go | ||
yaml_docs.go | ||
yaml_docs.md | ||
yaml_docs_test.go |
Documentation generation
Options
DisableAutoGenTag
You may set cmd.DisableAutoGenTag = true
to entirely remove the auto generated string "Auto generated by spf13/cobra..."
from any documentation source.
InitDefaultCompletionCmd
You may call cmd.InitDefaultCompletionCmd()
to document the default autocompletion command.