Infra/rougail
9
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc for check

Browse Source
This commit is contained in:
Emmanuel Garette
2021-02-15 15:17:23 +01:00
parent d1a39e5183
commit 5821b62f39
13 changed files with 135 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/fill/README.md
View File

@ -3,6 +3,4 @@
Une variable calculée est une variable donc sa valeur est le résultat d'une fonction python.
- [Valeur calculée de la variable](value.md)
- [Cible de la fonction](../target/variable.md)
- [Paramètre de la fonction](../param/README.md)
- [Réfinition](redefine.md)

16
doc/fill/redefine.md
View File

@ -6,9 +6,7 @@ Dans un premier dictionnaire déclarons notre variable et notre calcule :
```
<variables>
<family name="family">
<variable name="my_calculated_variable"/>
</family>
<variable name="my_calculated_variable"/>
</variables>
<constraints>
<fill name="return_no">
@ -21,9 +19,7 @@ Dans un second dictionnaire il est possible de redéfinir le calcul :
```
<variables>
<family name="family">
<variable name="my_calculated_variable" redefine="True"/>
</family>
<variable name="my_calculated_variable" redefine="True"/>
</variables>
<constraints>
<fill name="return_yes">
@ -44,9 +40,7 @@ Dans un premier dictionnaire déclarons notre variable et notre calcule :
```
<variables>
<family name="family">
<variable name="my_calculated_variable"/>
</family>
<variable name="my_calculated_variable"/>
</variables>
<constraints>
<fill name="return_no">
@ -59,8 +53,6 @@ Dans un second dictionnaire supprimer ce calcul :
```
<variables>
<family name="family">
<variable name="my_calculated_variable" redefine="True" remove_fill="True"/>
</family>
<variable name="my_calculated_variable" redefine="True" remove_fill="True"/>
</variables>
```

27
doc/fill/value.md
View File

@ -6,9 +6,7 @@ Créons une variable dont la valeur est retournée par la fonction "return_no" :
```
<variables>
<family name="family">
<variable name="my_calculated_variable"/>
</family>
<variable name="my_calculated_variable"/>
</variables>
<constraints>
<fill name="return_no">
@ -24,9 +22,9 @@ def return_no():
return 'no'
```
La [cible](../target/variable.md) du calcul est ici "my_calculated_variable".
La [cible (de type variable)](../target/variable.md) du calcul est ici "my_calculated_variable".
Dans ce cas, la valeur par défaut est la valeur retournée par la fonction (ici "no"), elle sera calculée tant que l'utilisateur n'a pas de spécifié une valeur à cette variable.
Dans ce cas, la valeur par défaut est la valeur retournée par la fonction (ici "no"), elle sera calculée tant que l'utilisateur n'a pas de spécifié de valeur à cette variable.
Attention, si une valeur par défaut est définit dans la variable "my_calculated_variable" :
@ -61,17 +59,15 @@ Il est également possible de calculer [une variable d'une famille dynamique](..
```
<variables>
<family name='family'>
<variable name='suffixes' type='string' description="Suffixes of dynamic family" multi="True">
<value>val1</value>
<value>val2</value>
</variable>
<variable name="my_variable" type="string" description="My variable">
<value>val</value>
</variable>
</family>
<variable name='suffixes' type='string' description="Suffixes of dynamic family" multi="True">
<value>val1</value>
<value>val2</value>
</variable>
<variable name="my_variable" type="string" description="My variable">
<value>val</value>
</variable>
<family name='dyn' dynamic="suffixes">
<variable name="my_calculated_variable_dyn_" type="string" description="My calculated variable"/>
<variable name="my_calculated_variable_dyn\_" type="string" description="My calculated variable"/>
<value>val</value>
</variable>
</family>
@ -114,4 +110,3 @@ def return_value_suffix(value, suffix):
Par défaut les variables calculées ne sont pas des variables obligatoires.
Dans ce cas un calcul peut retourner "None" ou "", mais surtout un utilisateur peut spécifier une valeur nulle à cette variable. Dans ce cas le calcul ne sera plus réalisé.