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

doc: redefine

Browse source
This commit is contained in:
egarette@silique.fr 2026-06-20 14:32:35 +02:00
parent abb0ec7063
commit 2c50bc60c8
1 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/format_content/mutability.rst
View file

@ -10,7 +10,11 @@ To summarize, an :term:`integrator` allows the :ref:`structured data <structured
redefine
A redefine is a redefinition of all or part of the parameters of a variable as it was previously defined.
A redefine is a redefinition of all or part of the parameters of a variable or a family as it was previously defined.
.. note::
Adding a variable to a family is not considered redefining the family. This is implicitly permitted. Redefining a family requires modifying one or more of its parameters.
.. seealso::
@ -112,3 +116,14 @@ If we modify the `redefine.yml` :term:`structure file`:
└──────────────────────┴────────────────┘
Here we can see that the variable has the original description, but the new type.
Exception
~~~~~~~~~
We cannot change a parameter for a variable or a family implicitly.
This is always true, unless you want to change the default value of a child of a custom type in a family.
.. seealso::
See the tutorial with a real world sample :ref:`custom type <tutorial_custom_type>`.