-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #900 from saschagrunert/author-improvement
Improve docs generation for cli.Authors
- Loading branch information
Showing
8 changed files
with
97 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,4 @@ | ||
*.coverprofile | ||
*.orig | ||
node_modules/ | ||
vendor | ||
vendor |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
% greet(8) | ||
% greet(8) | ||
|
||
% Harrison | ||
% Harrison <harrison@lolwut.com> | ||
% Oliver Allen <oliver@toyshop.com> | ||
|
||
# NAME | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
% greet(8) | ||
% greet(8) | ||
|
||
% Harrison | ||
% Harrison <harrison@lolwut.com> | ||
% Oliver Allen <oliver@toyshop.com> | ||
|
||
# NAME | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,7 @@ | ||
% greet(8) | ||
% greet(8) | ||
|
||
% Harrison | ||
% Harrison <harrison@lolwut.com> | ||
% Oliver Allen <oliver@toyshop.com> | ||
|
||
# NAME | ||
|
||
|