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

docs(multi-help): modifications after proofreading

Browse source
This commit is contained in:
gwen 2026-05-30 08:10:43 +02:00
parent 93800b558b
commit d6dcc712fb
3 changed files with 8 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/tutorial/examples.rst
View file

@ -87,7 +87,7 @@ we can see that the `no_proxy` variable has no user data settings.
..
rougail -m firefox/ --types types/proxy -u yaml -yf config/01/config.yml
we do indeed obtain the value empty list `[]` for the `no_proxy` variable:
We do indeed obtain the value empty list `[]` for the `no_proxy` variable:
.. raw:: html
:url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_120/config/03/output_ro.html
@ -113,7 +113,7 @@ Just to be thorough, let's look at what happens in a case where there is a value
:language: yaml
:caption: The :file:`config/03/config.yml` user data file with some value set
We launch the Rougail ClI
We launch the Rougail CLI:
.. raw:: html
:url: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/commit/v1.1_120/config/02/cmd_ro.txt
@ -242,15 +242,14 @@ In the same way, this help `"Connections to localhost, 127.0.0.1/8 and ::1 are n
.. type-along:: The difference between the `description` parameter and the `help` parameter
The help section serves as supplementary documentation regarding the description parameter.
Please do not mix the `description` parameter and the `help` parameter's variable usage.
Please do not mix the `description` parameter and the `help` parameter's variable usage.
A `description` allows you to describe the expected value(s) of a variable concisely and clearly.
The description can be long and detailed.
A `help` helps to clarify any ambiguity about the variable's purpose.
It is designed to be clear precise and short, much like the help of some
command-line utility when you type the command with the `--help` or `-h` option.
A `help` helps to clarify any ambiguity about the variable’s purpose. It can be long and detailed.
.. keypoints:: Key points
- We have seen how to give examples, simply with the `examples` parameter

2
docs/tutorial/index.rst
View file

@ -57,7 +57,7 @@ Let's dive into this **configuration options validation** use case.
jinja
customtype
nullable
web_address
webaddress
multiple
examples
practice1

4
docs/tutorial/multiple.rst
View file

@ -25,9 +25,9 @@ Variable with multiple values
git switch --detach v1.1_110
A conditional disabled non mandatory variable with type domainname and parameters
--------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------
In order to fit with our use case, we need a variable that takes as its value the domain names that are allowed to pass through the proxy, if it is enabled. We already used before in this tutorial the `domainname` type, which perfectly matches our needs here.
In order to fit with our use case, we need a variable that takes as its value the domain names authorized to pass through the proxy, if it is enabled. We already used before in this tutorial the `domainname` type, which perfectly matches our needs here.
We will just need to add certain parameters associated to this `domainname` type, as we will see.
We're gonna put it in another :term:`structure file` named :file:`firefox/40-no_proxy.yml`.