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

docs(underscore_parameter): proofreading

Browse source
This commit is contained in:
gwen 2026-06-01 15:05:47 +02:00
parent e40ade0b64
commit 2edf7bd91c
1 changed files with 15 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/tutorial/underscore_parameter.rst
View file

@ -1,11 +1,17 @@
A variable name that conflict with a defined family's attribute A variable name conflicts with a family attribute
============================================================================== ==========================================================
.. objectives:: Objectives .. objectives:: Objectives
Have a good variable name is really important. When a variable name conflicts with a family attribute,
do we have to abandon the variable name choice we made?
No because having a suitable variable name is really important.
The variable name you chose is undoubtedly the best.
We will learn how to create a variable name that conflict with a defineed attribute name. Sometimes, the choice of a variable's name may correspond very exactly
to an attribute of the family in which that variable is placed...
In this section, we will learn how to create a variable name that conflict with a defined attribute name.
.. prerequisites:: Prerequisites .. prerequisites:: Prerequisites
@ -27,6 +33,8 @@ A variable name that conflict with a defined family's attribute
.. type-along:: Let's recap how far we've come .. type-along:: Let's recap how far we've come
FIXME: changer le nom leadership
We have this leadership family in its structure definition file: We have this leadership family in its structure definition file:
.. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_202/foxyproxy/00-foxyproxy.yml .. extinclude:: https://forge.cloud.silique.fr/stove/rougail-tutorials/raw/tag/v1.1_202/foxyproxy/00-foxyproxy.yml
@ -34,8 +42,8 @@ We have this leadership family in its structure definition file:
:language: yaml :language: yaml
:caption: The `proxies` family with `leadership` type in the :file:`foxyproxy/00-foxyproxy.yml` structure file :caption: The `proxies` family with `leadership` type in the :file:`foxyproxy/00-foxyproxy.yml` structure file
The variable "type" that conflit with the family attribute "type" A variable name that conflicts with a known the variable's attribute "type"
--------------------------------------------------------------------- ----------------------------------------------------------------------------
Choice a good variable name is important. It's with this name that user will interact with here value. Choice a good variable name is important. It's with this name that user will interact with here value.
@ -54,7 +62,7 @@ Let's create a family named `manual` which obviously corresponds to the proxy's
:language: yaml :language: yaml
:caption: The `proxies` family with `leadership` type and a variable with the name `type` in the :file:`foxyproxy/00-foxyproxy.yml` structure file :caption: The `proxies` family with `leadership` type and a variable with the name `type` in the :file:`foxyproxy/00-foxyproxy.yml` structure file
Technically it's possible to put `_` in front of each attribute name, but it's still less readable. Technically it's possible to put `_` at the beginning of each attribute name, but it's still less readable.
.. keypoints:: Let's review the key points .. keypoints:: Let's review the key points