docs: standardise on definition lists for options

Harmonizes the option listing including formatting in a similar manner to the
synopsis of each entry.
This commit is contained in:
David Adam
2022-03-11 23:56:20 +08:00
parent cf85bf9be3
commit e23e52a8e9
30 changed files with 470 additions and 240 deletions

View File

@@ -21,16 +21,16 @@ The block can be removed. Any events which triggered while the block was in plac
Event blocks should not be confused with code blocks, which are created with ``begin``, ``if``, ``while`` or ``for``
The following parameters are available:
The following options are available:
**-l** or **--local**
Release the block automatically at the end of the current innermost code block scope
Release the block automatically at the end of the current innermost code block scope.
**-g** or **--global**
Never automatically release the lock
Never automatically release the lock.
**-e** or **--erase**
Release global block
Release global block.
Example
-------