Specifying usage examples in the spec

Open
#3 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Domain
cli, documentation

Research direction

Read the linked help-functions, bin/generate, and subcommands/backup files in the dokku-postgres example to understand how CLI help and Markdown are generated. Then inspect this repository’s current CLI specification approach and determine how command examples with descriptions would fit. Done means the specification can represent and show examples in the relevant subcommand section.

Written by the indexing model from the issue text.

Description

The dokku project uses some faux reflection and fancy footwork to generate cli help output as well as markdown docs from files. 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.

Dominant language
Rust
Stars
1k
Forks
59
Avg merge
5h 58m
Merged PRs (30d)
362

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jdx/usage

All issues in jdx/usage

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.