mirror of
https://github.com/spf13/cobra
synced 2024-11-05 05:17:12 +00:00
02a0d2fbc9
This patch modifies the GenMarkdownCustom to skip writing a Synopsis header with the `cmd.Short` duplicated both before and after the header. Instead, it only writes the `### Synopsis` header and the paragraph when a `cmd.Long` has some kind of content in it. Adds `TestGenMdDocWithNoLongOrSynopsis` as the test case. Signed-off-by: Marc Lopez <marc5.12@outlook.com> |
||
---|---|---|
.. | ||
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.