feat(docs): Include Description and UsageText in docs output (#1287 )

Include Description as part of the DESCRIPTION section, and put UsageText (if it is non-zero) into the Usage subsection.

2021-07-06 20:20:47 -04:00

1012 B

Raw Blame History

% greet 8

NAME

greet - Some app

SYNOPSIS

greet

DESCRIPTION

Description of the application.

Usage:

app [first_arg] [second_arg]

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

usage, u

standard usage text

Usage for the usage text
- formatted:  Based on the specified ConfigMap and summon secrets.yml
- list:       Inspect the environment for a specific process running on a Pod
- for_effect: Compare 'namespace' environment with 'local'

```
func() { ... }
```

Should be a part of the same code block