Specifying usage examples in the spec
Open
- Dominant language
- Rust
- Stars
- 1k
- Forks
- 59
- Avg merge
- 5h 58m
- Merged PRs (30d)
- 362
Description
The dokku project uses some [faux reflection](https://github.com/dokku/dokku-postgres/blob/master/help-functions) and [fancy footwork](https://github.com/dokku/dokku-postgres/blob/master/bin/generate) to generate cli help output as well as markdown docs [from files](https://github.com/dokku/dokku-postgres/blob/master/subcommands/backup). One thing that is nice is that we can show examples to users for usage.
I'm wondering if that would be possible to somehow spec out. Examples have a `cli command` as well as a `description` of the command, and are shown in the section for that particular subcommand.
Contributor guide
Assessment
This issue has not been assessed yet.