cobra/doc
Yash Ladha bf11ab6321
fix: func name in doc strings (#1885)
Corrected the function name at the start of doc strings, as per the convention
outlined in official go documentation: https://go.dev/blog/godoc
2022-12-25 15:08:39 -05:00
..
cmd_test.go add missing license headers (#1809) 2022-09-16 07:55:56 -04:00
man_docs_test.go add missing license headers (#1809) 2022-09-16 07:55:56 -04:00
man_docs.go add missing license headers (#1809) 2022-09-16 07:55:56 -04:00
man_docs.md Fix #401 (#402) 2017-04-19 14:39:58 +02:00
man_examples_test.go add missing license headers (#1809) 2022-09-16 07:55:56 -04:00
md_docs_test.go add missing license headers (#1809) 2022-09-16 07:55:56 -04:00
md_docs.go add missing license headers (#1809) 2022-09-16 07:55:56 -04:00
md_docs.md Change links from http:// to https:// (#1695) 2022-05-17 14:28:13 -04:00
README.md feat: make InitDefaultCompletionCmd public (#1467) 2022-10-10 19:06:30 -04:00
rest_docs_test.go add missing license headers (#1809) 2022-09-16 07:55:56 -04:00
rest_docs.go fix: func name in doc strings (#1885) 2022-12-25 15:08:39 -05:00
rest_docs.md Change links from http:// to https:// (#1695) 2022-05-17 14:28:13 -04:00
util.go add missing license headers (#1809) 2022-09-16 07:55:56 -04:00
yaml_docs_test.go add missing license headers (#1809) 2022-09-16 07:55:56 -04:00
yaml_docs.go add missing license headers (#1809) 2022-09-16 07:55:56 -04:00
yaml_docs.md Change links from http:// to https:// (#1695) 2022-05-17 14:28:13 -04:00

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.