feat: number => integer in documentation
This commit is contained in:
parent
1277cce9d9
commit
360c97c581
3 changed files with 10 additions and 10 deletions
|
|
@ -268,14 +268,14 @@ Here is a second example with a boolean variable:
|
||||||
type: jinja
|
type: jinja
|
||||||
jinja: 'false'
|
jinja: 'false'
|
||||||
|
|
||||||
And a multiple value of the number type:
|
And a multiple value of the integer type:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
---
|
---
|
||||||
version: '1.1'
|
version: '1.1'
|
||||||
my_calculated_variable:
|
my_calculated_variable:
|
||||||
type: number
|
type: integer
|
||||||
multi: true
|
multi: true
|
||||||
default:
|
default:
|
||||||
type: jinja
|
type: jinja
|
||||||
|
|
@ -545,7 +545,7 @@ Calculation via an index
|
||||||
- val1
|
- val1
|
||||||
- val2
|
- val2
|
||||||
follower1:
|
follower1:
|
||||||
type: number
|
type: integer
|
||||||
default:
|
default:
|
||||||
type: index
|
type: index
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -229,14 +229,14 @@ If the `type` attribute is not set, Rougail infers a `string` type for the `prox
|
||||||
|
|
||||||
.. type-along:: type setting
|
.. type-along:: type setting
|
||||||
|
|
||||||
If the operator sets an option value for example with the `number` type, like this:
|
If the operator sets an option value for example with the `integer` type, like this:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block:: yaml
|
||||||
|
|
||||||
---
|
---
|
||||||
example_var:
|
example_var:
|
||||||
description: Configure Proxy Access to the Internet
|
description: Configure Proxy Access to the Internet
|
||||||
type: number
|
type: integer
|
||||||
|
|
||||||
Then Rougail will expect a `int` or a `float` as a value for the `example_var` variable.
|
Then Rougail will expect a `int` or a `float` as a value for the `example_var` variable.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -77,7 +77,7 @@ Parameters
|
||||||
* - **default**
|
* - **default**
|
||||||
- Default value(s) of the variable.
|
- Default value(s) of the variable.
|
||||||
|
|
||||||
This value is typed, you must correctly fill out the YAML file to avoid defining a value with an incorrect type. For example, a `number` must be a digit type, a multiple variable must be a `list` type, ...
|
This value is typed, you must correctly fill out the YAML file to avoid defining a value with an incorrect type. For example, a `integer` must be a digit type, a multiple variable must be a `list` type, ...
|
||||||
|
|
||||||
For a non :term:`leading` multiple variable, the first value defined in the list will also be the default value proposed if a new value is added to this variable.
|
For a non :term:`leading` multiple variable, the first value defined in the list will also be the default value proposed if a new value is added to this variable.
|
||||||
|
|
||||||
|
|
@ -203,11 +203,11 @@ This type enables the variable to define the values that are accepted by this va
|
||||||
"1"
|
"1"
|
||||||
|
|
||||||
"true"
|
"true"
|
||||||
* - number
|
* - integer
|
||||||
- a number
|
- a integer
|
||||||
- `min_number`: minimum number allowed
|
- `min_integer`: minimum integer allowed
|
||||||
|
|
||||||
`max_number`: maximum number allowed
|
`max_integer`: maximum integer allowed
|
||||||
- 1
|
- 1
|
||||||
* - float
|
* - float
|
||||||
- a floating number
|
- a floating number
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue