Skip to main content

Module examples

Module examples 

Source
Expand description

trg --examples: worked examples of every option, printed as text.

This is living documentation, and tests/examples.rs keeps it alive. It builds the logs/ tree described in FILES, runs the trg part of every example against it, and checks the exit code each one claims. It also fails when an option in --help has no example. So a new flag, a renamed one, or a change in what a command does breaks the build until this file says so.

Structs§

Example
One example: a shell line and what it does.
File
A file in the example tree.
Section

Constants§

FILES
The tree every example searches. tests/examples.rs builds exactly this.
SECTIONS

Functions§

render
The whole text of trg --examples.