From 360c97c58147b29c36a82148d0c39f490489424e Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sun, 26 Oct 2025 13:31:47 +0100 Subject: [PATCH] feat: number => integer in documentation --- docs/fill.rst | 6 +++--- docs/tutorial/preliminary.rst | 4 ++-- docs/variable.rst | 10 +++++----- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/fill.rst b/docs/fill.rst index db69bf4a7..c892ff5aa 100644 --- a/docs/fill.rst +++ b/docs/fill.rst @@ -268,14 +268,14 @@ Here is a second example with a boolean variable: type: jinja jinja: 'false' -And a multiple value of the number type: +And a multiple value of the integer type: .. code-block:: yaml --- version: '1.1' my_calculated_variable: - type: number + type: integer multi: true default: type: jinja @@ -545,7 +545,7 @@ Calculation via an index - val1 - val2 follower1: - type: number + type: integer default: type: index diff --git a/docs/tutorial/preliminary.rst b/docs/tutorial/preliminary.rst index b827831a9..136ea7f6d 100644 --- a/docs/tutorial/preliminary.rst +++ b/docs/tutorial/preliminary.rst @@ -229,14 +229,14 @@ If the `type` attribute is not set, Rougail infers a `string` type for the `prox .. 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 --- example_var: 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. diff --git a/docs/variable.rst b/docs/variable.rst index 315a45cc4..4fb61257b 100644 --- a/docs/variable.rst +++ b/docs/variable.rst @@ -77,7 +77,7 @@ Parameters * - **default** - 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. @@ -203,11 +203,11 @@ This type enables the variable to define the values that are accepted by this va "1" "true" - * - number - - a number - - `min_number`: minimum number allowed + * - integer + - a integer + - `min_integer`: minimum integer allowed - `max_number`: maximum number allowed + `max_integer`: maximum integer allowed - 1 * - float - a floating number