diff --git a/docs/tutorial/underscore_parameter.rst b/docs/tutorial/underscore_parameter.rst index c35caecdb..5416873d7 100644 --- a/docs/tutorial/underscore_parameter.rst +++ b/docs/tutorial/underscore_parameter.rst @@ -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 - 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 @@ -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 +FIXME: changer le nom leadership + 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 @@ -34,8 +42,8 @@ We have this leadership family in its structure definition file: :language: yaml :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. @@ -54,7 +62,7 @@ Let's create a family named `manual` which obviously corresponds to the proxy's :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 -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