From 91ffd193365d058899d60c6021086f76d2889ad2 Mon Sep 17 00:00:00 2001 From: gwen Date: Fri, 21 Feb 2025 20:26:08 +0100 Subject: [PATCH] typos --- docs/tutorial/disable.rst | 27 --------------------------- docs/tutorial/preliminary.rst | 5 +++-- docs/tutorial/proxymode.rst | 10 ++-------- 3 files changed, 5 insertions(+), 37 deletions(-) delete mode 100644 docs/tutorial/disable.rst diff --git a/docs/tutorial/disable.rst b/docs/tutorial/disable.rst deleted file mode 100644 index bb0cb821e..000000000 --- a/docs/tutorial/disable.rst +++ /dev/null @@ -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` - - - - - - - - - - - - diff --git a/docs/tutorial/preliminary.rst b/docs/tutorial/preliminary.rst index 93d842a87..49d73d7e4 100644 --- a/docs/tutorial/preliminary.rst +++ b/docs/tutorial/preliminary.rst @@ -94,7 +94,8 @@ Rougail waits for the `proxy_mode` configuration option's value to be set. mandatory 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. .. 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:: - default values + default value A default value is a variable value that is predefined, that is, this value is placed right in the structure file. diff --git a/docs/tutorial/proxymode.rst b/docs/tutorial/proxymode.rst index 0e82992b0..fe6ed43c7 100644 --- a/docs/tutorial/proxymode.rst +++ b/docs/tutorial/proxymode.rst @@ -152,13 +152,7 @@ otherwise we will get an error if we try to access this variable: ┗━━ - manual.http_proxy.address (HTTP address) -Because this variable is mandatory. - -.. glossary:: - - mandatory - - A variable is defined as mandatory if it **must** have a value. +Because this variable is :term:`mandatory`. .. 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 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 can add :term:`parameters` to variables to refine their behavior + - we can add :term:`parameter`\ s to variables to refine their behavior **Progress**