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

typos

Browse source
This commit is contained in:
gwen 2025-02-21 20:26:08 +01:00
parent fce54f7c84
commit 91ffd19336
3 changed files with 5 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/tutorial/disable.rst
View file

@ -1,27 +0,0 @@
A family can disapear in the outerspace
===========================================
.. objectives:: Objectives
In this section we will learn:
- what is a *property*
- the `disabled` propety
What is a disabled variable or family is, and why it is interesting to do that.
.. prerequisites:: Reminders
- We have three variables: :confval:`proxy_mode`, :confval:`address` and :confval:`port`

5
docs/tutorial/preliminary.rst
View file

@ -94,7 +94,8 @@ Rougail waits for the `proxy_mode` configuration option's value to be set.
mandatory mandatory
A variable is mandatory when a value is required, that is, `None` is not an option. A variable is mandatory when a value is required, that is, `None` is not an option.
It **must** have a defined value.
Then we just add a variable's description, which is a good practice. Then we just add a variable's description, which is a good practice.
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_011/firefox/00-proxy.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_011/firefox/00-proxy.yml
@ -111,7 +112,7 @@ We need a **default value**.
.. glossary:: .. glossary::
default values default value
A default value is a variable value that is predefined, that is, this value is placed A default value is a variable value that is predefined, that is, this value is placed
right in the structure file. right in the structure file.

10
docs/tutorial/proxymode.rst
View file

@ -152,13 +152,7 @@ otherwise we will get an error if we try to access this variable:
<span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address) <span style="color: #ff0000">┗━━ </span> - manual.http_proxy.address (HTTP address)
</pre> </pre>
Because this variable is mandatory. Because this variable is :term:`mandatory`.
.. glossary::
mandatory
A variable is defined as mandatory if it **must** have a value.
.. type-along:: user files are where the user values lives .. type-along:: user files are where the user values lives
@ -324,7 +318,7 @@ Take a look at lines 14 to 17.
- we now know what a :term:`mandatory` variable is - we now know what a :term:`mandatory` variable is
- we kwow how to set a variable's user value (in a :term:`user file`) - we kwow how to set a variable's user value (in a :term:`user file`)
- we have the big picture : the :term:`configuration`, which is (the structure files + the user files) - we have the big picture : the :term:`configuration`, which is (the structure files + the user files)
- we can add :term:`parameters` to variables to refine their behavior - we can add :term:`parameter`\ s to variables to refine their behavior
**Progress** **Progress**