mirror
/
cobra
mirror of https://github.com/spf13/cobra.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity
1,010 Commits 4 Branches 24 Tags 17 MiB
Commit Graph

19 Commits

Author SHA1 Message Date
Lars Kajes 5d16684e88
fix inconsistencies in md generation 2023-10-11 14:40:55 +02:00
Unai Martinez-Corral 9e6b58afc7
update copyright year (#1927) 2023-03-05 21:28:31 -05:00
Unai Martinez-Corral 6d978a911e
add missing license headers (#1809) 2022-09-16 07:55:56 -04:00
Hugo 25f5bb5f97
Prefer ReplaceAll instead of Replace(..., -1) (#1530) 2022-05-14 14:10:36 -06:00
John McBride ff416ad438
Revert "Add the ability to specify a filePostpender in GenMarkdownTreeCustom (#1270)" (#1317) 
This reverts commit 23a6174c7f.
 2021-01-23 16:05:55 -07:00
Joon-Ho Son 23a6174c7f
Add the ability to specify a filePostpender in GenMarkdownTreeCustom (#1270) 2021-01-20 20:33:16 -07:00
Marc Lopez Rubio 02a0d2fbc9
doc: GenMarkdown skip Synopsis on empty long cmd (#1207) 
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>
 2020-08-26 09:18:51 -06:00
James DeFelice 0ab5b6bcfc doc: hide hidden parent flags (#686) 
* fixes #685
 2018-04-24 12:15:12 -04:00
Allen Sun 3a5f27b046 doc: Add a necessary blank line after SEE ALSO (#592) 
Signed-off-by: Allen Sun <shlallen1990@gmail.com>
 2017-12-04 11:43:02 +01:00
Allen Sun 45a52e208c doc: Remove one additional blank line after Synopsis (#591) 
Signed-off-by: Allen Sun <shlallen1990@gmail.com>
 2017-12-04 10:21:50 +01:00
Albert Nigmatzianov ca57f0f5db doc: Ad help flag and cmd when generating docs 2017-05-20 19:28:06 +02:00
Albert Nigmatzianov 6bfe2ba1a2 doc: Add docs 2017-05-09 11:14:48 +02:00
Albert Nigmatzianov 97af803f3b doc: Cleanup md_docs 
Performance gain:
benchmark                        old ns/op     new ns/op     delta
BenchmarkGenMarkdownToFile-4     23096         10295         -55.43%

benchmark                        old allocs     new allocs     delta
BenchmarkGenMarkdownToFile-4     47             48             +2.13%

benchmark                        old bytes     new bytes     delta
BenchmarkGenMarkdownToFile-4     1984          2832          +42.74%
 2017-04-26 21:30:17 +02:00
Albert Nigmatzianov f95d58bdf3 Fix #401 (#402) 
* doc: Add and edit docs

* doc: Add tests
 2017-04-19 14:39:58 +02:00
Albert Nigmatzianov 0960ff7fa9 Rename IsHelpCommand to IsAdditionalHelpTopicCommand (#398) 
Fixes #393
 2017-03-09 10:37:15 -05:00
Garth Kidd 8e6aca4182 Use filepath.Join, not string math. Fixes #226. 2016-01-17 11:25:20 +11:00
Daniel Martí eb5040e69e Treat write errors in markdown doc generation 
This code was already using io.Writer, but was completely ignoring write
errors.

The most worrying part is how GenMarkdownTreeCustom used an unnecessary
buffer to then dump all of its contents on a file, and instead of
returning an error on file creation/writing, it would just exit the
entire program.
 2016-01-06 12:21:04 +01:00
Daniel Martí ea06b29c10 Simplify GenMarkdownTreeCustom signature 2016-01-06 11:59:08 +01:00
Frank Schroeder b3f29e98e6 Issue #195: Move doc generation into separate pkg 
* Move man_docs and md_docs into new doc pkg
* Replace *bytes.Buffer with io.Writer
* Replace c == cmd.helpCommand with c.IsHelpCommand()
* Remove redundant len(children) == 0 check in HasSeeAlso
* Duplicate test setup for doc generation
 2015-12-24 09:01:59 -05:00