Skip to content

Commit 62a0eda

Browse files
committed
clarify options name behaviour
1 parent 01caa74 commit 62a0eda

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

source/reference/options.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ Fields
3939

4040
- ``name``: Name of the option/setting.
4141

42-
When generated, giza automatically
43-
prepends two dashes ``-`` to the beginning except when the first
42+
If the directive is ``option``, giza automatically
43+
prepends two dashes ``-`` to the beginning of the filename unless the first
4444
character of the name value is ``<`` or ``-``.
4545

4646
The following would therefore render as ``--host``:
@@ -160,7 +160,7 @@ Built-In Variables
160160
------------------
161161

162162
- ``{{role}}``: automatically replaced by a link to the option or
163-
setting (e.g. :option:`mongod --dbpath`).
163+
setting (e.g. :option:`mongod.--dbpath`).
164164

165165
- ``{{program}}``: automatically replaced by the a link to the option
166166
or setting's specified ``program`` (e.g. :binary:`~bin.mongod`).

0 commit comments

Comments
 (0)