docs: omnibus cleanup

Includes harmonizing the display of options and arguments, standardising
terminology, using the envvar directive more broadly, adding help options to all
commands that support them, simplifying some language, and tidying up multiple
formatting issues.

string documentation is not changed.
This commit is contained in:
David Adam
2022-03-12 00:18:41 +08:00
parent e23e52a8e9
commit 3a23fdf359
66 changed files with 278 additions and 143 deletions

View File

@@ -25,9 +25,7 @@ Note that command substitutions in a case statement will be evaluated even if it
Example
-------
If the variable \$animal contains the name of an animal, the following code would attempt to classify it:
If the variable :envvar:`animal` contains the name of an animal, the following code would attempt to classify it:
::