From d6dcc712fb573ea3a9ed0f0e5da2842120919dbc Mon Sep 17 00:00:00 2001 From: gwen Date: Sat, 30 May 2026 08:10:43 +0200 Subject: [PATCH] docs(multi-help): modifications after proofreading --- docs/tutorial/examples.rst | 11 +++++------ docs/tutorial/index.rst | 2 +- docs/tutorial/multiple.rst | 4 ++-- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/tutorial/examples.rst b/docs/tutorial/examples.rst index 1f7f49e5c..d7c063f84 100644 --- a/docs/tutorial/examples.rst +++ b/docs/tutorial/examples.rst @@ -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 diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst index 509189c3c..61173afa6 100644 --- a/docs/tutorial/index.rst +++ b/docs/tutorial/index.rst @@ -57,7 +57,7 @@ Let's dive into this **configuration options validation** use case. jinja customtype nullable - web_address + webaddress multiple examples practice1 diff --git a/docs/tutorial/multiple.rst b/docs/tutorial/multiple.rst index 988ef45ec..11add1d1c 100644 --- a/docs/tutorial/multiple.rst +++ b/docs/tutorial/multiple.rst @@ -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`.