doc(rename)
This commit is contained in:
parent
570b22525b
commit
4cad2ce30f
6 changed files with 10 additions and 10 deletions
|
|
@ -48,7 +48,7 @@ Parameters
|
||||||
`string`
|
`string`
|
||||||
- Additional help associated with the family.
|
- Additional help associated with the family.
|
||||||
|
|
||||||
.. seealso:: tutorial with a real world sample :doc:`help parameter <../tutorial/examples>` (the tutorial focuses on variable, but the principle is the same for a family)
|
.. seealso:: tutorial with a real world sample :doc:`help parameter <../tutorial/document>` (the tutorial focuses on variable, but the principle is the same for a family)
|
||||||
|
|
||||||
* - **mode**, **_mode**
|
* - **mode**, **_mode**
|
||||||
|
|
||||||
|
|
@ -186,7 +186,7 @@ Here is a simple example:
|
||||||
You can have a look at the tutorial with a real world sample:
|
You can have a look at the tutorial with a real world sample:
|
||||||
|
|
||||||
- :doc:`family <../tutorial/family>`
|
- :doc:`family <../tutorial/family>`
|
||||||
- :doc:`help parameter <../tutorial/examples>` (the tutorial focuses on variable, but the principle is the same for a family)
|
- :doc:`help parameter <../tutorial/document>` (the tutorial focuses on variable, but the principle is the same for a family)
|
||||||
|
|
||||||
A dynamically built family
|
A dynamically built family
|
||||||
-----------------------------
|
-----------------------------
|
||||||
|
|
@ -221,7 +221,7 @@ This will dynamically create two families:
|
||||||
|
|
||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
You can have a look at the tutorial with a real world sample :doc:`dynamically built family <../tutorial/dynfam>`
|
You can have a look at the tutorial with a real world sample :doc:`dynamically built family <../tutorial/dynamic>`
|
||||||
|
|
||||||
Sequence of homogeneous elements
|
Sequence of homogeneous elements
|
||||||
---------------------------------------
|
---------------------------------------
|
||||||
|
|
|
||||||
|
|
@ -74,7 +74,7 @@ Parameters
|
||||||
`string`
|
`string`
|
||||||
- Additional help associated with the variable.
|
- Additional help associated with the variable.
|
||||||
|
|
||||||
.. seealso:: tutorial with a real world sample :doc:`help parameter <../tutorial/examples>`
|
.. seealso:: tutorial with a real world sample :doc:`help parameter <../tutorial/document>`
|
||||||
|
|
||||||
* - **mode**
|
* - **mode**
|
||||||
|
|
||||||
|
|
@ -112,7 +112,7 @@ Parameters
|
||||||
`list`
|
`list`
|
||||||
- List of examples to illustrate possible values for a variable
|
- List of examples to illustrate possible values for a variable
|
||||||
|
|
||||||
.. seealso:: tutorial with a real world sample :doc:`examples parameter <../tutorial/examples>`
|
.. seealso:: tutorial with a real world sample :doc:`examples parameter <../tutorial/document>`
|
||||||
|
|
||||||
* - **test**
|
* - **test**
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -43,7 +43,7 @@ Help is a property that only concerns documentation.
|
||||||
A help helps to clarify any ambiguity about the variable’s purpose.
|
A help helps to clarify any ambiguity about the variable’s purpose.
|
||||||
It can be long and detailed.
|
It can be long and detailed.
|
||||||
|
|
||||||
.. seealso:: tutorial with a real world sample :doc:`help <../tutorial/examples>`
|
.. seealso:: tutorial with a real world sample :doc:`help <../tutorial/document>`
|
||||||
|
|
||||||
Give examples of possible value
|
Give examples of possible value
|
||||||
-------------------------------
|
-------------------------------
|
||||||
|
|
@ -54,7 +54,7 @@ Don't hesitate to guide the :term:`operator` with relevant examples.
|
||||||
|
|
||||||
Examples is a property that only concerns documentation.
|
Examples is a property that only concerns documentation.
|
||||||
|
|
||||||
.. seealso:: tutorial with a real world sample :doc:`examples <../tutorial/examples>`
|
.. seealso:: tutorial with a real world sample :doc:`examples <../tutorial/document>`
|
||||||
|
|
||||||
Specialized variables
|
Specialized variables
|
||||||
-----------------------
|
-----------------------
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
.. _dynfam:
|
.. _dynamic:
|
||||||
|
|
||||||
A dynamically built family
|
A dynamically built family
|
||||||
==========================
|
==========================
|
||||||
|
|
@ -140,7 +140,7 @@ that allow us to define dynamically family names.
|
||||||
|
|
||||||
identifier
|
identifier
|
||||||
|
|
||||||
In the :ref:`dynamically built family creation field <dynfam>` we call an identifier
|
In the :ref:`dynamically built family creation field <dynamic>` we call an identifier
|
||||||
an item that defines a family name. An item is a variable on which an iteration
|
an item that defines a family name. An item is a variable on which an iteration
|
||||||
on keywords will be carried out.
|
on keywords will be carried out.
|
||||||
|
|
||||||
|
|
@ -53,7 +53,7 @@ Let's dive into this **configuration options validation** use case.
|
||||||
types
|
types
|
||||||
calculated
|
calculated
|
||||||
properties
|
properties
|
||||||
dynfam
|
dynamic
|
||||||
jinja
|
jinja
|
||||||
customtype
|
customtype
|
||||||
nullable
|
nullable
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue