Improve docs generation for cli.Authors
This allows specifying multiple authors, whereas no available authors will be formatted correctly now. Signed-off-by: Sascha Grunert <sgrunert@suse.com>
This commit is contained in:
7
testdata/expected-doc-full.man
vendored
7
testdata/expected-doc-full.man
vendored
@@ -1,7 +1,10 @@
|
||||
.nh
|
||||
.TH greet(8)
|
||||
.TH greet(8)
|
||||
|
||||
.SH Harrison
|
||||
.SH Harrison harrison@lolwut.com
|
||||
\[la]mailto:harrison@lolwut.com\[ra]
|
||||
Oliver Allen oliver@toyshop.com
|
||||
\[la]mailto:oliver@toyshop.com\[ra]
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
|
5
testdata/expected-doc-full.md
vendored
5
testdata/expected-doc-full.md
vendored
@@ -1,6 +1,7 @@
|
||||
% greet(8)
|
||||
% greet(8)
|
||||
|
||||
% Harrison
|
||||
% Harrison <harrison@lolwut.com>
|
||||
% Oliver Allen <oliver@toyshop.com>
|
||||
|
||||
# NAME
|
||||
|
||||
|
61
testdata/expected-doc-no-authors.md
vendored
Normal file
61
testdata/expected-doc-no-authors.md
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
% greet(8)
|
||||
|
||||
|
||||
# NAME
|
||||
|
||||
greet - Some app
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
greet
|
||||
|
||||
```
|
||||
[--another-flag|-b]
|
||||
[--flag|--fl|-f]=[value]
|
||||
[--socket|-s]=[value]
|
||||
```
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
app [first_arg] [second_arg]
|
||||
|
||||
**Usage**:
|
||||
|
||||
```
|
||||
greet [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
|
||||
```
|
||||
|
||||
# GLOBAL OPTIONS
|
||||
|
||||
**--another-flag, -b**: another usage text
|
||||
|
||||
**--flag, --fl, -f**="":
|
||||
|
||||
**--socket, -s**="": some 'usage' text (default: value)
|
||||
|
||||
|
||||
# COMMANDS
|
||||
|
||||
## config, c
|
||||
|
||||
another usage test
|
||||
|
||||
**--another-flag, -b**: another usage text
|
||||
|
||||
**--flag, --fl, -f**="":
|
||||
|
||||
### sub-config, s, ss
|
||||
|
||||
another usage test
|
||||
|
||||
**--sub-command-flag, -s**: some usage text
|
||||
|
||||
**--sub-flag, --sub-fl, -s**="":
|
||||
|
||||
## info, i, in
|
||||
|
||||
retrieve generic information
|
||||
|
||||
## some-command
|
||||
|
||||
|
5
testdata/expected-doc-no-commands.md
vendored
5
testdata/expected-doc-no-commands.md
vendored
@@ -1,6 +1,7 @@
|
||||
% greet(8)
|
||||
% greet(8)
|
||||
|
||||
% Harrison
|
||||
% Harrison <harrison@lolwut.com>
|
||||
% Oliver Allen <oliver@toyshop.com>
|
||||
|
||||
# NAME
|
||||
|
||||
|
5
testdata/expected-doc-no-flags.md
vendored
5
testdata/expected-doc-no-flags.md
vendored
@@ -1,6 +1,7 @@
|
||||
% greet(8)
|
||||
% greet(8)
|
||||
|
||||
% Harrison
|
||||
% Harrison <harrison@lolwut.com>
|
||||
% Oliver Allen <oliver@toyshop.com>
|
||||
|
||||
# NAME
|
||||
|
||||
|
Reference in New Issue
Block a user