stove/rougail
3
0
Fork 0
Code Issues 5 Pull requests 1 Projects Releases Wiki Activity

last review

Browse source
This commit is contained in:
gwen 2025-12-10 08:22:18 +01:00
parent fe4e98624a
commit aabc937d1c
3 changed files with 5 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/tutorial/domainname.rst
View file

@ -403,8 +403,8 @@ Let's add one more variable in the `manual` family, with a much more basic type:
.. note:: .. note::
- it is not necessary to declare the variable as a boolean type - it is not necessary to declare the variable as a boolean type,
this type is *inferred* by the `true` default value the type is *inferred* by the presence of the `true` default value
- we have decided to create a new structure file :file:`firefox/20-manual.yml`. - we have decided to create a new structure file :file:`firefox/20-manual.yml`.
This is not necessary but usefull, please have a look at the :ref:`structure file organization and naming conventions <namingconvention>` This is not necessary but usefull, please have a look at the :ref:`structure file organization and naming conventions <namingconvention>`

4
docs/tutorial/family.rst
View file

@ -154,7 +154,6 @@ Putting a variable inside of a family or a sub family
We are going to put a variable inside of a family or a sub family We are going to put a variable inside of a family or a sub family
Let's create a variable in the `http_proxy` family. Let's create a variable in the `http_proxy` family.
This time, the type of this new variable is a `domainname` type:
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_022/firefox/10-manual.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_022/firefox/10-manual.yml
:language: yaml :language: yaml
@ -185,9 +184,6 @@ In short, let's describe our `address` variable like this:
This is the HTTP address of the proxy This is the HTTP address of the proxy
.. note:: We encountered here a new type of variable there: the `domainname` type.
There are a bunch of types available in Rougail.
We have reached the definition of the address in the `http_proxy` family; there will be other variables to define in this family. We have reached the definition of the address in the `http_proxy` family; there will be other variables to define in this family.
.. image:: images/firefox_manual_family.png .. image:: images/firefox_manual_family.png

7
docs/tutorial/preliminary.rst
View file

@ -196,7 +196,8 @@ We can see here that the variable's description string "Configure Proxy Access t
to refer to the `proxy_mode` variable. to refer to the `proxy_mode` variable.
.. note:: The description is used in UI tools and outputs instead of the variable name. .. note:: The description is used in UI tools and outputs instead of the variable name.
The goal here is to provide an explanation of the variable for the user,
not to show the technical name of the variable as defined by the :term:`integrator`.
Set a default value Set a default value
--------------------- ---------------------
@ -255,15 +256,13 @@ The chosen value is indicated in the Rougail's CLI output as the default choice.
.. ..
proxy_mode: No proxy # Configure Proxy Access to the Internet proxy_mode: No proxy # Configure Proxy Access to the Internet
- and there is the verbose way of setting a default value: - and there is the verbose way of setting a default value:
.. code-block:: yaml .. code-block:: yaml
proxy_mode: proxy_mode:
default: No proxy
description: Configure Proxy Access to the Internet description: Configure Proxy Access to the Internet
default: No proxy
There are some other :term:`short-hand ways <short-hand notation>` with Rougail that you may encounter There are some other :term:`short-hand ways <short-hand notation>` with Rougail that you may encounter
as you read the Rougail's documentation and tutorial. as you read the Rougail's documentation and tutorial.