last review

This commit is contained in:
gwen 2025-12-10 08:07:34 +01:00
parent c850c11e98
commit fe4e98624a

View file

@ -172,6 +172,32 @@ You have two way to define a variable's description:
proxy_mode: # Configure Proxy Access to the Internet
If we launch the Rougail CLI command:
.. raw:: html
:class: terminal
:url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_002/config/01/cmd_rw.txt
we have this output:
.. raw:: html
:class: output
:url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_002/config/01/output_rw.html
..
<pre>╭──────────────────── Caption ─────────────────────╮
│ <span style="color: #ff0000">Undocumented but modified variable</span> <span style="color: #ffd700">Default value</span> │
╰──────────────────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 <span style="color: #ff0000">Configure Proxy Access to the Internet</span>: <span style="color: #ffd700">null</span>
</pre>
We can see here that the variable's description string "Configure Proxy Access to the Internet" is used
to refer to the `proxy_mode` variable.
.. note:: The description is used in UI tools and outputs instead of the variable name.
Set a default value
---------------------
@ -222,11 +248,16 @@ The chosen value is indicated in the Rougail's CLI output as the default choice.
- here is the short-hand default setting and description:
.. code-block:: yaml
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_003/firefox/00-proxy.yml
:language: yaml
:caption: The short-hand way of setting a default value and a description
..
proxy_mode: No proxy # Configure Proxy Access to the Internet
- here is the verbose way:
- and there is the verbose way of setting a default value:
.. code-block:: yaml