Module help_text

Module help_text 

Source
Expand description

Per-command detailed help text, returned by help <command>, plus the multi-line mode help blobs used by help with no arguments. Per-command detailed help text.

for_command(cmd) returns a multi-line detailed help block for a specific command, or None if the command name is unknown.

ALL_COMMANDS lists every command we have detailed help for. The lint test in this module iterates the list and runs the accessibility lint over every entry.

This module also holds the three multi-line help blobs that list commands for each REPL mode: CAT, APRS, and D-STAR. These were previously println!-driven functions in commands.rs; moving them here lets the lint test exercise them uniformly with the per-command entries.

Constants§

ALL_COMMANDS
The names of every command that has a detailed help entry. Used by help all to iterate and by the lint test to assert coverage.
APRS_MODE_HELP
APRS mode help text listing APRS-specific commands.
CAT_MODE_HELP
CAT mode help text listing all available commands.
DSTAR_MODE_HELP
D-STAR gateway mode help text.

Functions§

for_command
Return detailed help text for a single command, or None if the command name is not recognized.