Skip to main content

cli_reference

Function cli_reference 

Source
pub fn cli_reference() -> String
Expand description

The command reference in docs/using/cli.md: every command, its full argument spec, and what it is for.

Not usage. Help is an index — the reader is at a prompt and wants the name of the thing, and thirty-two full argument specs is what they have to read past to find it. A reference page is the opposite situation: the reader is already looking the command up, and the specs are the reason they came. Rendering both from the same table keeps them from disagreeing without pretending they answer the same question.

readme_cheatsheet is the third answer to the same table, for the third reader: somebody deciding whether to try this at all.