From ffca00f3c4fd9cb9f873f1a5e35149fd9f533737 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sun, 28 Jun 2026 14:51:37 +0200 Subject: [PATCH] fix: help line with only a space in family description --- src/rougail/output_doc/utils.py | 2 +- tests/results/test/00_7help.adoc | 7 +++++ tests/results/test/00_7help.gitlab.md | 9 +++--- tests/results/test/00_7help.html | 5 +++ tests/results/test/00_7help.json | 19 ++++++++++++ tests/results/test/00_7help.md | 9 +++--- tests/results/test/00_7help.sh | 7 +++++ tests/results/test/20_7help_family.adoc | 21 +++++++++++++ tests/results/test/20_7help_family.gitlab.md | 21 +++++++++++++ tests/results/test/20_7help_family.html | 13 ++++++++ tests/results/test/20_7help_family.json | 31 +++++++++++++++++++ tests/results/test/20_7help_family.md | 17 +++++++++- tests/results/test/20_7help_family.sh | 18 +++++++++++ tests/results/test_examples/00_7help.adoc | 2 ++ .../results/test_examples/00_7help.gitlab.md | 2 ++ tests/results/test_examples/00_7help.html | 6 ++-- tests/results/test_examples/00_7help.md | 2 ++ tests/results/test_examples/00_7help.sh | 2 ++ .../test_examples/20_7help_family.adoc | 4 +++ .../test_examples/20_7help_family.gitlab.md | 4 +++ .../test_examples/20_7help_family.html | 4 +++ .../results/test_examples/20_7help_family.md | 4 +++ .../results/test_examples/20_7help_family.sh | 4 +++ .../test_examples_comment/00_7help.adoc | 2 ++ .../test_examples_comment/00_7help.gitlab.md | 2 ++ .../test_examples_comment/00_7help.html | 6 ++-- .../results/test_examples_comment/00_7help.md | 2 ++ .../results/test_examples_comment/00_7help.sh | 2 ++ .../20_7help_family.adoc | 4 +++ .../20_7help_family.gitlab.md | 4 +++ .../20_7help_family.html | 8 +++-- .../test_examples_comment/20_7help_family.md | 4 +++ .../test_examples_comment/20_7help_family.sh | 4 +++ tests/results/test_namespace/00_7help.adoc | 7 +++++ .../results/test_namespace/00_7help.gitlab.md | 9 +++--- tests/results/test_namespace/00_7help.html | 5 +++ tests/results/test_namespace/00_7help.json | 19 ++++++++++++ tests/results/test_namespace/00_7help.md | 9 +++--- tests/results/test_namespace/00_7help.sh | 7 +++++ .../test_namespace/20_7help_family.adoc | 21 +++++++++++++ .../test_namespace/20_7help_family.gitlab.md | 21 +++++++++++++ .../test_namespace/20_7help_family.html | 13 ++++++++ .../test_namespace/20_7help_family.json | 31 +++++++++++++++++++ .../results/test_namespace/20_7help_family.md | 17 +++++++++- .../results/test_namespace/20_7help_family.sh | 18 +++++++++++ .../test_namespace_examples/00_7help.adoc | 2 ++ .../00_7help.gitlab.md | 2 ++ .../test_namespace_examples/00_7help.html | 6 ++-- .../test_namespace_examples/00_7help.md | 2 ++ .../test_namespace_examples/00_7help.sh | 2 ++ .../20_7help_family.adoc | 4 +++ .../20_7help_family.gitlab.md | 4 +++ .../20_7help_family.html | 4 +++ .../20_7help_family.md | 4 +++ .../20_7help_family.sh | 4 +++ .../00_7help.adoc | 2 ++ .../00_7help.gitlab.md | 2 ++ .../00_7help.html | 6 ++-- .../00_7help.md | 2 ++ .../00_7help.sh | 2 ++ .../20_7help_family.adoc | 4 +++ .../20_7help_family.gitlab.md | 4 +++ .../20_7help_family.html | 8 +++-- .../20_7help_family.md | 4 +++ .../20_7help_family.sh | 4 +++ .../00_7help.adoc | 7 +++++ .../00_7help.changelog.adoc | 7 +++++ .../00_7help.changelog.gitlab.md | 9 +++--- .../00_7help.changelog.html | 5 +++ .../00_7help.changelog.md | 9 +++--- .../00_7help.changelog.sh | 7 +++++ .../00_7help.gitlab.md | 9 +++--- .../00_7help.html | 5 +++ .../00_7help.json | 19 ++++++++++++ .../test_namespace_without_family/00_7help.md | 9 +++--- .../test_namespace_without_family/00_7help.sh | 7 +++++ .../20_7help_family.adoc | 8 +++-- .../20_7help_family.changelog.adoc | 8 +++-- .../20_7help_family.changelog.gitlab.md | 9 +++--- .../20_7help_family.changelog.html | 7 +++-- .../20_7help_family.changelog.md | 9 +++--- .../20_7help_family.changelog.sh | 21 +++++++------ .../20_7help_family.gitlab.md | 9 +++--- .../20_7help_family.html | 7 +++-- .../20_7help_family.json | 31 +++++++++++++++++++ .../20_7help_family.md | 9 +++--- .../20_7help_family.sh | 21 +++++++------ .../results/test_without_family/00_7help.adoc | 7 +++++ .../00_7help.changelog.adoc | 7 +++++ .../00_7help.changelog.gitlab.md | 9 +++--- .../00_7help.changelog.html | 5 +++ .../test_without_family/00_7help.changelog.md | 9 +++--- .../test_without_family/00_7help.changelog.sh | 7 +++++ .../test_without_family/00_7help.gitlab.md | 9 +++--- .../results/test_without_family/00_7help.html | 5 +++ .../results/test_without_family/00_7help.json | 19 ++++++++++++ tests/results/test_without_family/00_7help.md | 9 +++--- tests/results/test_without_family/00_7help.sh | 7 +++++ .../test_without_family/20_7help_family.adoc | 8 +++-- .../20_7help_family.changelog.adoc | 8 +++-- .../20_7help_family.changelog.gitlab.md | 9 +++--- .../20_7help_family.changelog.html | 7 +++-- .../20_7help_family.changelog.md | 9 +++--- .../20_7help_family.changelog.sh | 21 +++++++------ .../20_7help_family.gitlab.md | 9 +++--- .../test_without_family/20_7help_family.html | 7 +++-- .../test_without_family/20_7help_family.json | 31 +++++++++++++++++++ .../test_without_family/20_7help_family.md | 9 +++--- .../test_without_family/20_7help_family.sh | 21 +++++++------ 109 files changed, 809 insertions(+), 155 deletions(-) diff --git a/src/rougail/output_doc/utils.py b/src/rougail/output_doc/utils.py index 42747cc21..af7e16170 100644 --- a/src/rougail/output_doc/utils.py +++ b/src/rougail/output_doc/utils.py @@ -55,10 +55,10 @@ def dump(informations): def to_phrase(msg, type_="variable"): """Add maj for the first character and ends with dot""" + msg = str(msg).strip() if not msg: # replace None to empty string return "" - msg = str(msg).strip() # a phrase must ends with a dot if type_ == "variable": msg = add_dot(msg) diff --git a/tests/results/test/00_7help.adoc b/tests/results/test/00_7help.adoc index f85f2c803..7c6bd7c61 100644 --- a/tests/results/test/00_7help.adoc +++ b/tests/results/test/00_7help.adoc @@ -12,5 +12,12 @@ With useful information. `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The second variable. + Multi line Help +With useful information. +| **var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The third variable with spaces. + +Multi line with space. + +Help. + With useful information. |==== \ No newline at end of file diff --git a/tests/results/test/00_7help.gitlab.md b/tests/results/test/00_7help.gitlab.md index 4264a12d3..ad7194b8d 100644 --- a/tests/results/test/00_7help.gitlab.md +++ b/tests/results/test/00_7help.gitlab.md @@ -1,4 +1,5 @@ -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | \ No newline at end of file +| Variable | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.
Multi line with space.

Help.

With useful information. | \ No newline at end of file diff --git a/tests/results/test/00_7help.html b/tests/results/test/00_7help.html index 2b265bd12..f11543e34 100644 --- a/tests/results/test/00_7help.html +++ b/tests/results/test/00_7help.html @@ -10,6 +10,11 @@ Help With useful information. var2
string basic mandatoryThe second variable.
Multi line Help +With useful information. +var3
string basic mandatoryThe third variable with spaces.
Multi line with space. + +Help. + With useful information. \ No newline at end of file diff --git a/tests/results/test/00_7help.json b/tests/results/test/00_7help.json index 0a573fe7c..2b98900a3 100644 --- a/tests/results/test/00_7help.json +++ b/tests/results/test/00_7help.json @@ -36,5 +36,24 @@ "mode": "basic", "type": "variable", "variable_type": "string" + }, + "var3": { + "path": "var3", + "name": "var3", + "description": "The third variable with spaces.", + "help": [ + "Multi line with space.\n \nHelp.\n\nWith useful information." + ], + "properties": [ + { + "type": "property", + "name": "mandatory", + "ori_name": "mandatory", + "access_control": false + } + ], + "mode": "basic", + "type": "variable", + "variable_type": "string" } } \ No newline at end of file diff --git a/tests/results/test/00_7help.md b/tests/results/test/00_7help.md index 4264a12d3..ad7194b8d 100644 --- a/tests/results/test/00_7help.md +++ b/tests/results/test/00_7help.md @@ -1,4 +1,5 @@ -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | \ No newline at end of file +| Variable | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.
Multi line with space.

Help.

With useful information. | \ No newline at end of file diff --git a/tests/results/test/00_7help.sh b/tests/results/test/00_7help.sh index 2a2db7e5d..c5784dd94 100644 --- a/tests/results/test/00_7help.sh +++ b/tests/results/test/00_7help.sh @@ -12,5 +12,12 @@ โ”‚  string   basic   mandatory  โ”‚ Multi line โ”‚ โ”‚ โ”‚ Help โ”‚ โ”‚ โ”‚ With useful information. โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ var3 โ”‚ The third variable with spaces. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ Multi line with space. โ”‚ +โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ Help. โ”‚ +โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ With useful information. โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ diff --git a/tests/results/test/20_7help_family.adoc b/tests/results/test/20_7help_family.adoc index ab593ca72..d25768c20 100644 --- a/tests/results/test/20_7help_family.adoc +++ b/tests/results/test/20_7help_family.adoc @@ -38,4 +38,25 @@ With useful information. + | Variable | **family2.var** + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` +|==== + +== The third family with space + +==== +**๐Ÿ›ˆ Informations** + +Multi line. + + + +Help. + +With useful information. + +**Path**: family3 + +`basic` + +==== + +[cols="1a,1a"] +|==== +| Variable | Description +| **family3.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | A variable. |==== \ No newline at end of file diff --git a/tests/results/test/20_7help_family.gitlab.md b/tests/results/test/20_7help_family.gitlab.md index 9bcd8c5bb..52a2b4703 100644 --- a/tests/results/test/20_7help_family.gitlab.md +++ b/tests/results/test/20_7help_family.gitlab.md @@ -38,4 +38,25 @@ |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | + + +
The third family with space + +> [!note] ๐Ÿ›ˆ Informations +> Multi line. +> +> +> +> Help. +> +> With useful information. +> +> **Path**: family3 +> +> `basic` + +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **family3.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | +
\ No newline at end of file diff --git a/tests/results/test/20_7help_family.html b/tests/results/test/20_7help_family.html index 40aa2342f..c760953fc 100644 --- a/tests/results/test/20_7help_family.html +++ b/tests/results/test/20_7help_family.html @@ -22,4 +22,17 @@ Multi line.
Help.
With useful information.
Path: family2
family2.var
string basic mandatory + + +

The third family with space

+ +Multi line.

Help.
With useful information.
Path: family3
basic + + + + + + + +
Variable Description
family3.var
string basic mandatory
A variable.
\ No newline at end of file diff --git a/tests/results/test/20_7help_family.json b/tests/results/test/20_7help_family.json index 52e6501fc..3e6f428ca 100644 --- a/tests/results/test/20_7help_family.json +++ b/tests/results/test/20_7help_family.json @@ -58,5 +58,36 @@ "variable_type": "string" } } + }, + "family3": { + "type": "family", + "informations": { + "path": "family3", + "name": "family3", + "description": "The third family with space", + "help": [ + "Multi line\n \nHelp\nWith useful information." + ], + "properties": [], + "mode": "basic" + }, + "children": { + "var": { + "path": "family3.var", + "name": "var", + "description": "A variable.", + "properties": [ + { + "type": "property", + "name": "mandatory", + "ori_name": "mandatory", + "access_control": false + } + ], + "mode": "basic", + "type": "variable", + "variable_type": "string" + } + } } } \ No newline at end of file diff --git a/tests/results/test/20_7help_family.md b/tests/results/test/20_7help_family.md index 733a8ce14..08e073954 100644 --- a/tests/results/test/20_7help_family.md +++ b/tests/results/test/20_7help_family.md @@ -26,4 +26,19 @@ | Variable | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | \ No newline at end of file +| **family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | + +# The third family with space + +> [!NOTE] +> +> Multi line.\ +> \ +> Help.\ +> With useful information.\ +> **Path**: family3\ +> `basic` + +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **family3.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | \ No newline at end of file diff --git a/tests/results/test/20_7help_family.sh b/tests/results/test/20_7help_family.sh index 9ab00950b..8c82d1371 100644 --- a/tests/results/test/20_7help_family.sh +++ b/tests/results/test/20_7help_family.sh @@ -34,3 +34,21 @@ โ”‚  string   basic   mandatory  โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ +The third family with space + +โ–Œ ๐Ÿ›ˆ Informations +โ–Œ  +โ–Œ Multi line. +โ–Œ  +โ–Œ Help. +โ–Œ With useful information. +โ–Œ Path: family3 +โ–Œ  basic  + +โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ +โ”ƒ Variable  โ”ƒ Description  โ”ƒ +โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ +โ”‚ family3.var โ”‚ A variable. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ + diff --git a/tests/results/test_examples/00_7help.adoc b/tests/results/test_examples/00_7help.adoc index fd7c5e125..8f9245ee9 100644 --- a/tests/results/test_examples/00_7help.adoc +++ b/tests/results/test_examples/00_7help.adoc @@ -5,6 +5,7 @@ --- var1: example var2: example +var3: example ---- @@ -15,4 +16,5 @@ var2: example --- var1: example var2: example +var3: example ---- diff --git a/tests/results/test_examples/00_7help.gitlab.md b/tests/results/test_examples/00_7help.gitlab.md index dafddaaa8..3ed9f048c 100644 --- a/tests/results/test_examples/00_7help.gitlab.md +++ b/tests/results/test_examples/00_7help.gitlab.md @@ -4,6 +4,7 @@ --- var1: example var2: example +var3: example ``` @@ -14,6 +15,7 @@ var2: example --- var1: example var2: example +var3: example ``` \ No newline at end of file diff --git a/tests/results/test_examples/00_7help.html b/tests/results/test_examples/00_7help.html index fa8a91c5c..d4c5d36a7 100644 --- a/tests/results/test_examples/00_7help.html +++ b/tests/results/test_examples/00_7help.html @@ -2,10 +2,12 @@
---
 var1: example
-var2: example
+var2: example +var3: example

Example with all modifiable variables

---
 var1: example
-var2: example
\ No newline at end of file +var2: example +var3: example \ No newline at end of file diff --git a/tests/results/test_examples/00_7help.md b/tests/results/test_examples/00_7help.md index 0cfbb4adb..21365c232 100644 --- a/tests/results/test_examples/00_7help.md +++ b/tests/results/test_examples/00_7help.md @@ -4,6 +4,7 @@ --- var1: example var2: example +var3: example ``` # Example with all modifiable variables @@ -12,4 +13,5 @@ var2: example --- var1: example var2: example +var3: example ``` \ No newline at end of file diff --git a/tests/results/test_examples/00_7help.sh b/tests/results/test_examples/00_7help.sh index e18055fcc..90690ee11 100644 --- a/tests/results/test_examples/00_7help.sh +++ b/tests/results/test_examples/00_7help.sh @@ -3,10 +3,12 @@ ---  var1: example  var2: example  +var3: example  Example with all modifiable variables ---  var1: example  var2: example  +var3: example  diff --git a/tests/results/test_examples/20_7help_family.adoc b/tests/results/test_examples/20_7help_family.adoc index 3f1e8bb98..d54b6aee7 100644 --- a/tests/results/test_examples/20_7help_family.adoc +++ b/tests/results/test_examples/20_7help_family.adoc @@ -7,6 +7,8 @@ family1: var: example family2: var: example +family3: + var: example ---- @@ -19,4 +21,6 @@ family1: var: example family2: var: example +family3: + var: example ---- diff --git a/tests/results/test_examples/20_7help_family.gitlab.md b/tests/results/test_examples/20_7help_family.gitlab.md index 26488f892..a4ec9b0f1 100644 --- a/tests/results/test_examples/20_7help_family.gitlab.md +++ b/tests/results/test_examples/20_7help_family.gitlab.md @@ -6,6 +6,8 @@ family1: var: example family2: var: example +family3: + var: example ``` @@ -18,6 +20,8 @@ family1: var: example family2: var: example +family3: + var: example ``` \ No newline at end of file diff --git a/tests/results/test_examples/20_7help_family.html b/tests/results/test_examples/20_7help_family.html index b4309d4b4..613b19c28 100644 --- a/tests/results/test_examples/20_7help_family.html +++ b/tests/results/test_examples/20_7help_family.html @@ -4,6 +4,8 @@ family1: var: example family2: + var: example +family3: var: example

Example with all modifiable variables

@@ -12,4 +14,6 @@ family2: family1: var: example family2: + var: example +family3: var: example \ No newline at end of file diff --git a/tests/results/test_examples/20_7help_family.md b/tests/results/test_examples/20_7help_family.md index e0ca61ad8..f52d17019 100644 --- a/tests/results/test_examples/20_7help_family.md +++ b/tests/results/test_examples/20_7help_family.md @@ -6,6 +6,8 @@ family1: var: example family2: var: example +family3: + var: example ``` # Example with all modifiable variables @@ -16,4 +18,6 @@ family1: var: example family2: var: example +family3: + var: example ``` \ No newline at end of file diff --git a/tests/results/test_examples/20_7help_family.sh b/tests/results/test_examples/20_7help_family.sh index 5de5dd5fa..1e4c3e51a 100644 --- a/tests/results/test_examples/20_7help_family.sh +++ b/tests/results/test_examples/20_7help_family.sh @@ -5,6 +5,8 @@  var: example  family2:   var: example  +family3:  + var: example  Example with all modifiable variables @@ -13,4 +15,6 @@  var: example  family2:   var: example  +family3:  + var: example  diff --git a/tests/results/test_examples_comment/00_7help.adoc b/tests/results/test_examples_comment/00_7help.adoc index 82519fed6..b892d5fe8 100644 --- a/tests/results/test_examples_comment/00_7help.adoc +++ b/tests/results/test_examples_comment/00_7help.adoc @@ -5,6 +5,7 @@ --- var1: example # The first variable var2: example # The second variable +var3: example # The third variable with spaces ---- @@ -15,4 +16,5 @@ var2: example # The second variable --- var1: example # The first variable var2: example # The second variable +var3: example # The third variable with spaces ---- diff --git a/tests/results/test_examples_comment/00_7help.gitlab.md b/tests/results/test_examples_comment/00_7help.gitlab.md index 3dbea0926..978171c59 100644 --- a/tests/results/test_examples_comment/00_7help.gitlab.md +++ b/tests/results/test_examples_comment/00_7help.gitlab.md @@ -4,6 +4,7 @@ --- var1: example # The first variable var2: example # The second variable +var3: example # The third variable with spaces ``` @@ -14,6 +15,7 @@ var2: example # The second variable --- var1: example # The first variable var2: example # The second variable +var3: example # The third variable with spaces ``` \ No newline at end of file diff --git a/tests/results/test_examples_comment/00_7help.html b/tests/results/test_examples_comment/00_7help.html index 0c4aab5c9..6cf4e7b26 100644 --- a/tests/results/test_examples_comment/00_7help.html +++ b/tests/results/test_examples_comment/00_7help.html @@ -2,10 +2,12 @@
---
 var1: example                 # The first variable
-var2: example                 # The second variable
+var2: example # The second variable +var3: example # The third variable with spaces

Example with all modifiable variables

---
 var1: example                 # The first variable
-var2: example                 # The second variable
\ No newline at end of file +var2: example # The second variable +var3: example # The third variable with spaces \ No newline at end of file diff --git a/tests/results/test_examples_comment/00_7help.md b/tests/results/test_examples_comment/00_7help.md index 3b009d942..b8e540bcc 100644 --- a/tests/results/test_examples_comment/00_7help.md +++ b/tests/results/test_examples_comment/00_7help.md @@ -4,6 +4,7 @@ --- var1: example # The first variable var2: example # The second variable +var3: example # The third variable with spaces ``` # Example with all modifiable variables @@ -12,4 +13,5 @@ var2: example # The second variable --- var1: example # The first variable var2: example # The second variable +var3: example # The third variable with spaces ``` \ No newline at end of file diff --git a/tests/results/test_examples_comment/00_7help.sh b/tests/results/test_examples_comment/00_7help.sh index 816c19b91..6aacc98f0 100644 --- a/tests/results/test_examples_comment/00_7help.sh +++ b/tests/results/test_examples_comment/00_7help.sh @@ -3,10 +3,12 @@ ---  var1: example # The first variable  var2: example # The second variable  +var3: example # The third variable with spaces  Example with all modifiable variables ---  var1: example # The first variable  var2: example # The second variable  +var3: example # The third variable with spaces  diff --git a/tests/results/test_examples_comment/20_7help_family.adoc b/tests/results/test_examples_comment/20_7help_family.adoc index 5d28856b0..76db1dc03 100644 --- a/tests/results/test_examples_comment/20_7help_family.adoc +++ b/tests/results/test_examples_comment/20_7help_family.adoc @@ -7,6 +7,8 @@ family1: # The first family var: example family2: # The second family var: example +family3: # The third family with space + var: example # A variable ---- @@ -19,4 +21,6 @@ family1: # The first family var: example family2: # The second family var: example +family3: # The third family with space + var: example # A variable ---- diff --git a/tests/results/test_examples_comment/20_7help_family.gitlab.md b/tests/results/test_examples_comment/20_7help_family.gitlab.md index 5446bfd6d..5c056bd8f 100644 --- a/tests/results/test_examples_comment/20_7help_family.gitlab.md +++ b/tests/results/test_examples_comment/20_7help_family.gitlab.md @@ -6,6 +6,8 @@ family1: # The first family var: example family2: # The second family var: example +family3: # The third family with space + var: example # A variable ``` @@ -18,6 +20,8 @@ family1: # The first family var: example family2: # The second family var: example +family3: # The third family with space + var: example # A variable ``` \ No newline at end of file diff --git a/tests/results/test_examples_comment/20_7help_family.html b/tests/results/test_examples_comment/20_7help_family.html index 3294be742..517ea2dc3 100644 --- a/tests/results/test_examples_comment/20_7help_family.html +++ b/tests/results/test_examples_comment/20_7help_family.html @@ -4,7 +4,9 @@ family1: # The first family var: example family2: # The second family - var: example + var: example +family3: # The third family with space + var: example # A variable

Example with all modifiable variables

@@ -12,4 +14,6 @@ family2: # The second family family1: # The first family var: example family2: # The second family - var: example \ No newline at end of file + var: example +family3: # The third family with space + var: example # A variable \ No newline at end of file diff --git a/tests/results/test_examples_comment/20_7help_family.md b/tests/results/test_examples_comment/20_7help_family.md index 67b95cd41..845e14d46 100644 --- a/tests/results/test_examples_comment/20_7help_family.md +++ b/tests/results/test_examples_comment/20_7help_family.md @@ -6,6 +6,8 @@ family1: # The first family var: example family2: # The second family var: example +family3: # The third family with space + var: example # A variable ``` # Example with all modifiable variables @@ -16,4 +18,6 @@ family1: # The first family var: example family2: # The second family var: example +family3: # The third family with space + var: example # A variable ``` \ No newline at end of file diff --git a/tests/results/test_examples_comment/20_7help_family.sh b/tests/results/test_examples_comment/20_7help_family.sh index 771409138..6fa97be69 100644 --- a/tests/results/test_examples_comment/20_7help_family.sh +++ b/tests/results/test_examples_comment/20_7help_family.sh @@ -5,6 +5,8 @@  var: example  family2: # The second family   var: example  +family3: # The third family with space  + var: example # A variable  Example with all modifiable variables @@ -13,4 +15,6 @@  var: example  family2: # The second family   var: example  +family3: # The third family with space  + var: example # A variable  diff --git a/tests/results/test_namespace/00_7help.adoc b/tests/results/test_namespace/00_7help.adoc index 0732af33b..1c6c4776d 100644 --- a/tests/results/test_namespace/00_7help.adoc +++ b/tests/results/test_namespace/00_7help.adoc @@ -23,5 +23,12 @@ With useful information. `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The second variable. + Multi line Help +With useful information. +| **rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The third variable with spaces. + +Multi line with space. + +Help. + With useful information. |==== \ No newline at end of file diff --git a/tests/results/test_namespace/00_7help.gitlab.md b/tests/results/test_namespace/00_7help.gitlab.md index 876cd5839..37239968c 100644 --- a/tests/results/test_namespace/00_7help.gitlab.md +++ b/tests/results/test_namespace/00_7help.gitlab.md @@ -7,9 +7,10 @@ > > `basic` -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| Variable | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.
Multi line with space.

Help.

With useful information. | \ No newline at end of file diff --git a/tests/results/test_namespace/00_7help.html b/tests/results/test_namespace/00_7help.html index dfabc3c46..96be01032 100644 --- a/tests/results/test_namespace/00_7help.html +++ b/tests/results/test_namespace/00_7help.html @@ -14,6 +14,11 @@ Help With useful information. rougail.var2
string basic mandatoryThe second variable.
Multi line Help +With useful information. +rougail.var3
string basic mandatoryThe third variable with spaces.
Multi line with space. + +Help. + With useful information. \ No newline at end of file diff --git a/tests/results/test_namespace/00_7help.json b/tests/results/test_namespace/00_7help.json index 2de586c97..93c5ab6d9 100644 --- a/tests/results/test_namespace/00_7help.json +++ b/tests/results/test_namespace/00_7help.json @@ -49,6 +49,25 @@ "mode": "basic", "type": "variable", "variable_type": "string" + }, + "var3": { + "path": "rougail.var3", + "name": "var3", + "description": "The third variable with spaces.", + "help": [ + "Multi line with space.\n \nHelp.\n\nWith useful information." + ], + "properties": [ + { + "type": "property", + "name": "mandatory", + "ori_name": "mandatory", + "access_control": false + } + ], + "mode": "basic", + "type": "variable", + "variable_type": "string" } } } diff --git a/tests/results/test_namespace/00_7help.md b/tests/results/test_namespace/00_7help.md index 116611602..5733ac8c5 100644 --- a/tests/results/test_namespace/00_7help.md +++ b/tests/results/test_namespace/00_7help.md @@ -6,7 +6,8 @@ > **Path**: rougail\ > `basic` -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | \ No newline at end of file +| Variable | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.
Multi line with space.

Help.

With useful information. | \ No newline at end of file diff --git a/tests/results/test_namespace/00_7help.sh b/tests/results/test_namespace/00_7help.sh index 4bceef9ba..6b6d2c8d4 100644 --- a/tests/results/test_namespace/00_7help.sh +++ b/tests/results/test_namespace/00_7help.sh @@ -20,5 +20,12 @@ โ”‚  string   basic   mandatory  โ”‚ Multi line โ”‚ โ”‚ โ”‚ Help โ”‚ โ”‚ โ”‚ With useful information. โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ rougail.var3 โ”‚ The third variable with spaces. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ Multi line with space. โ”‚ +โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ Help. โ”‚ +โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ With useful information. โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ diff --git a/tests/results/test_namespace/20_7help_family.adoc b/tests/results/test_namespace/20_7help_family.adoc index 62cff4ea9..bb94fa4da 100644 --- a/tests/results/test_namespace/20_7help_family.adoc +++ b/tests/results/test_namespace/20_7help_family.adoc @@ -49,4 +49,25 @@ With useful information. + | Variable | **rougail.family2.var** + `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` +|==== + +=== The third family with space + +==== +**๐Ÿ›ˆ Informations** + +Multi line. + + + +Help. + +With useful information. + +**Path**: rougail.family3 + +`basic` + +==== + +[cols="1a,1a"] +|==== +| Variable | Description +| **rougail.family3.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | A variable. |==== \ No newline at end of file diff --git a/tests/results/test_namespace/20_7help_family.gitlab.md b/tests/results/test_namespace/20_7help_family.gitlab.md index a5edf86dc..12e1f69a2 100644 --- a/tests/results/test_namespace/20_7help_family.gitlab.md +++ b/tests/results/test_namespace/20_7help_family.gitlab.md @@ -49,4 +49,25 @@ +
The third family with space + +> [!note] ๐Ÿ›ˆ Informations +> Multi line. +> +> +> +> Help. +> +> With useful information. +> +> **Path**: rougail.family3 +> +> `basic` + +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **rougail.family3.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | + +
+ \ No newline at end of file diff --git a/tests/results/test_namespace/20_7help_family.html b/tests/results/test_namespace/20_7help_family.html index 287cfcb20..4291c8e64 100644 --- a/tests/results/test_namespace/20_7help_family.html +++ b/tests/results/test_namespace/20_7help_family.html @@ -26,4 +26,17 @@ Multi line.
Help.
With useful information.
Path: rougail.fami rougail.family2.var
string basic mandatory + + +

The third family with space

+ +Multi line.

Help.
With useful information.
Path: rougail.family3
basic + + + + + + + +
Variable Description
rougail.family3.var
string basic mandatory
A variable.
\ No newline at end of file diff --git a/tests/results/test_namespace/20_7help_family.json b/tests/results/test_namespace/20_7help_family.json index 9769591f9..b0ec13c85 100644 --- a/tests/results/test_namespace/20_7help_family.json +++ b/tests/results/test_namespace/20_7help_family.json @@ -71,6 +71,37 @@ "variable_type": "string" } } + }, + "family3": { + "type": "family", + "informations": { + "path": "rougail.family3", + "name": "family3", + "description": "The third family with space", + "help": [ + "Multi line\n \nHelp\nWith useful information." + ], + "properties": [], + "mode": "basic" + }, + "children": { + "var": { + "path": "rougail.family3.var", + "name": "var", + "description": "A variable.", + "properties": [ + { + "type": "property", + "name": "mandatory", + "ori_name": "mandatory", + "access_control": false + } + ], + "mode": "basic", + "type": "variable", + "variable_type": "string" + } + } } } } diff --git a/tests/results/test_namespace/20_7help_family.md b/tests/results/test_namespace/20_7help_family.md index d408be56f..37004e461 100644 --- a/tests/results/test_namespace/20_7help_family.md +++ b/tests/results/test_namespace/20_7help_family.md @@ -34,4 +34,19 @@ | Variable | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | \ No newline at end of file +| **rougail.family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | + +## The third family with space + +> [!NOTE] +> +> Multi line.\ +> \ +> Help.\ +> With useful information.\ +> **Path**: rougail.family3\ +> `basic` + +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **rougail.family3.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | \ No newline at end of file diff --git a/tests/results/test_namespace/20_7help_family.sh b/tests/results/test_namespace/20_7help_family.sh index 69c197965..8301350e6 100644 --- a/tests/results/test_namespace/20_7help_family.sh +++ b/tests/results/test_namespace/20_7help_family.sh @@ -42,3 +42,21 @@ โ”‚  string   basic   mandatory  โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ + The third family with space + +โ–Œ ๐Ÿ›ˆ Informations +โ–Œ  +โ–Œ Multi line. +โ–Œ  +โ–Œ Help. +โ–Œ With useful information. +โ–Œ Path: rougail.family3 +โ–Œ  basic  + +โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ +โ”ƒ Variable  โ”ƒ Description  โ”ƒ +โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ +โ”‚ rougail.family3.var โ”‚ A variable. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ + diff --git a/tests/results/test_namespace_examples/00_7help.adoc b/tests/results/test_namespace_examples/00_7help.adoc index 85501f397..27aad7737 100644 --- a/tests/results/test_namespace_examples/00_7help.adoc +++ b/tests/results/test_namespace_examples/00_7help.adoc @@ -6,6 +6,7 @@ rougail: var1: example var2: example + var3: example ---- @@ -17,4 +18,5 @@ rougail: rougail: var1: example var2: example + var3: example ---- diff --git a/tests/results/test_namespace_examples/00_7help.gitlab.md b/tests/results/test_namespace_examples/00_7help.gitlab.md index bf15f005e..a6a480d74 100644 --- a/tests/results/test_namespace_examples/00_7help.gitlab.md +++ b/tests/results/test_namespace_examples/00_7help.gitlab.md @@ -5,6 +5,7 @@ rougail: var1: example var2: example + var3: example ``` @@ -16,6 +17,7 @@ rougail: rougail: var1: example var2: example + var3: example ``` \ No newline at end of file diff --git a/tests/results/test_namespace_examples/00_7help.html b/tests/results/test_namespace_examples/00_7help.html index a121dc444..1164d8b4f 100644 --- a/tests/results/test_namespace_examples/00_7help.html +++ b/tests/results/test_namespace_examples/00_7help.html @@ -3,11 +3,13 @@
---
 rougail:
   var1: example
-  var2: example
+ var2: example + var3: example

Example with all modifiable variables

---
 rougail:
   var1: example
-  var2: example
\ No newline at end of file + var2: example + var3: example \ No newline at end of file diff --git a/tests/results/test_namespace_examples/00_7help.md b/tests/results/test_namespace_examples/00_7help.md index d46456081..d4f4d40f9 100644 --- a/tests/results/test_namespace_examples/00_7help.md +++ b/tests/results/test_namespace_examples/00_7help.md @@ -5,6 +5,7 @@ rougail: var1: example var2: example + var3: example ``` # Example with all modifiable variables @@ -14,4 +15,5 @@ rougail: rougail: var1: example var2: example + var3: example ``` \ No newline at end of file diff --git a/tests/results/test_namespace_examples/00_7help.sh b/tests/results/test_namespace_examples/00_7help.sh index 0e6601c80..9775f9af9 100644 --- a/tests/results/test_namespace_examples/00_7help.sh +++ b/tests/results/test_namespace_examples/00_7help.sh @@ -4,6 +4,7 @@ rougail:   var1: example   var2: example  + var3: example  Example with all modifiable variables @@ -11,4 +12,5 @@ rougail:   var1: example   var2: example  + var3: example  diff --git a/tests/results/test_namespace_examples/20_7help_family.adoc b/tests/results/test_namespace_examples/20_7help_family.adoc index efdbb8378..e1b81b7f7 100644 --- a/tests/results/test_namespace_examples/20_7help_family.adoc +++ b/tests/results/test_namespace_examples/20_7help_family.adoc @@ -8,6 +8,8 @@ rougail: var: example family2: var: example + family3: + var: example ---- @@ -21,4 +23,6 @@ rougail: var: example family2: var: example + family3: + var: example ---- diff --git a/tests/results/test_namespace_examples/20_7help_family.gitlab.md b/tests/results/test_namespace_examples/20_7help_family.gitlab.md index c47cf4320..b3929ccaa 100644 --- a/tests/results/test_namespace_examples/20_7help_family.gitlab.md +++ b/tests/results/test_namespace_examples/20_7help_family.gitlab.md @@ -7,6 +7,8 @@ rougail: var: example family2: var: example + family3: + var: example ``` @@ -20,6 +22,8 @@ rougail: var: example family2: var: example + family3: + var: example ``` \ No newline at end of file diff --git a/tests/results/test_namespace_examples/20_7help_family.html b/tests/results/test_namespace_examples/20_7help_family.html index bad509d90..6715b65e8 100644 --- a/tests/results/test_namespace_examples/20_7help_family.html +++ b/tests/results/test_namespace_examples/20_7help_family.html @@ -5,6 +5,8 @@ rougail: family1: var: example family2: + var: example + family3: var: example

Example with all modifiable variables

@@ -14,4 +16,6 @@ rougail: family1: var: example family2: + var: example + family3: var: example \ No newline at end of file diff --git a/tests/results/test_namespace_examples/20_7help_family.md b/tests/results/test_namespace_examples/20_7help_family.md index 20753b84f..54bd9be9f 100644 --- a/tests/results/test_namespace_examples/20_7help_family.md +++ b/tests/results/test_namespace_examples/20_7help_family.md @@ -7,6 +7,8 @@ rougail: var: example family2: var: example + family3: + var: example ``` # Example with all modifiable variables @@ -18,4 +20,6 @@ rougail: var: example family2: var: example + family3: + var: example ``` \ No newline at end of file diff --git a/tests/results/test_namespace_examples/20_7help_family.sh b/tests/results/test_namespace_examples/20_7help_family.sh index c11730905..172872ab5 100644 --- a/tests/results/test_namespace_examples/20_7help_family.sh +++ b/tests/results/test_namespace_examples/20_7help_family.sh @@ -6,6 +6,8 @@  var: example   family2:   var: example  + family3:  + var: example  Example with all modifiable variables @@ -15,4 +17,6 @@  var: example   family2:   var: example  + family3:  + var: example  diff --git a/tests/results/test_namespace_examples_comment/00_7help.adoc b/tests/results/test_namespace_examples_comment/00_7help.adoc index 5ef3412a7..71fd2cc90 100644 --- a/tests/results/test_namespace_examples_comment/00_7help.adoc +++ b/tests/results/test_namespace_examples_comment/00_7help.adoc @@ -6,6 +6,7 @@ rougail: # Rougail var1: example # The first variable var2: example # The second variable + var3: example # The third variable with spaces ---- @@ -17,4 +18,5 @@ rougail: # Rougail rougail: # Rougail var1: example # The first variable var2: example # The second variable + var3: example # The third variable with spaces ---- diff --git a/tests/results/test_namespace_examples_comment/00_7help.gitlab.md b/tests/results/test_namespace_examples_comment/00_7help.gitlab.md index eab975a6a..f53ece477 100644 --- a/tests/results/test_namespace_examples_comment/00_7help.gitlab.md +++ b/tests/results/test_namespace_examples_comment/00_7help.gitlab.md @@ -5,6 +5,7 @@ rougail: # Rougail var1: example # The first variable var2: example # The second variable + var3: example # The third variable with spaces ``` @@ -16,6 +17,7 @@ rougail: # Rougail rougail: # Rougail var1: example # The first variable var2: example # The second variable + var3: example # The third variable with spaces ``` \ No newline at end of file diff --git a/tests/results/test_namespace_examples_comment/00_7help.html b/tests/results/test_namespace_examples_comment/00_7help.html index 5c87df21f..0f2c28857 100644 --- a/tests/results/test_namespace_examples_comment/00_7help.html +++ b/tests/results/test_namespace_examples_comment/00_7help.html @@ -3,11 +3,13 @@
---
 rougail:                      # Rougail
   var1: example               # The first variable
-  var2: example               # The second variable
+ var2: example # The second variable + var3: example # The third variable with spaces

Example with all modifiable variables

---
 rougail:                      # Rougail
   var1: example               # The first variable
-  var2: example               # The second variable
\ No newline at end of file + var2: example # The second variable + var3: example # The third variable with spaces \ No newline at end of file diff --git a/tests/results/test_namespace_examples_comment/00_7help.md b/tests/results/test_namespace_examples_comment/00_7help.md index 4864958ff..03c73b6ca 100644 --- a/tests/results/test_namespace_examples_comment/00_7help.md +++ b/tests/results/test_namespace_examples_comment/00_7help.md @@ -5,6 +5,7 @@ rougail: # Rougail var1: example # The first variable var2: example # The second variable + var3: example # The third variable with spaces ``` # Example with all modifiable variables @@ -14,4 +15,5 @@ rougail: # Rougail rougail: # Rougail var1: example # The first variable var2: example # The second variable + var3: example # The third variable with spaces ``` \ No newline at end of file diff --git a/tests/results/test_namespace_examples_comment/00_7help.sh b/tests/results/test_namespace_examples_comment/00_7help.sh index d4322ce2f..882c0897f 100644 --- a/tests/results/test_namespace_examples_comment/00_7help.sh +++ b/tests/results/test_namespace_examples_comment/00_7help.sh @@ -4,6 +4,7 @@ rougail: # Rougail   var1: example # The first variable   var2: example # The second variable  + var3: example # The third variable with spaces  Example with all modifiable variables @@ -11,4 +12,5 @@ rougail: # Rougail   var1: example # The first variable   var2: example # The second variable  + var3: example # The third variable with spaces  diff --git a/tests/results/test_namespace_examples_comment/20_7help_family.adoc b/tests/results/test_namespace_examples_comment/20_7help_family.adoc index 26d025f4d..1b5c63b69 100644 --- a/tests/results/test_namespace_examples_comment/20_7help_family.adoc +++ b/tests/results/test_namespace_examples_comment/20_7help_family.adoc @@ -8,6 +8,8 @@ rougail: # Rougail var: example family2: # The second family var: example + family3: # The third family with space + var: example # A variable ---- @@ -21,4 +23,6 @@ rougail: # Rougail var: example family2: # The second family var: example + family3: # The third family with space + var: example # A variable ---- diff --git a/tests/results/test_namespace_examples_comment/20_7help_family.gitlab.md b/tests/results/test_namespace_examples_comment/20_7help_family.gitlab.md index 7d437111c..ec34d8902 100644 --- a/tests/results/test_namespace_examples_comment/20_7help_family.gitlab.md +++ b/tests/results/test_namespace_examples_comment/20_7help_family.gitlab.md @@ -7,6 +7,8 @@ rougail: # Rougail var: example family2: # The second family var: example + family3: # The third family with space + var: example # A variable ``` @@ -20,6 +22,8 @@ rougail: # Rougail var: example family2: # The second family var: example + family3: # The third family with space + var: example # A variable ``` \ No newline at end of file diff --git a/tests/results/test_namespace_examples_comment/20_7help_family.html b/tests/results/test_namespace_examples_comment/20_7help_family.html index 6c9031631..f2d9a8e68 100644 --- a/tests/results/test_namespace_examples_comment/20_7help_family.html +++ b/tests/results/test_namespace_examples_comment/20_7help_family.html @@ -5,7 +5,9 @@ rougail: # Rougail family1: # The first family var: example family2: # The second family - var: example + var: example + family3: # The third family with space + var: example # A variable

Example with all modifiable variables

@@ -14,4 +16,6 @@ rougail: # Rougail family1: # The first family var: example family2: # The second family - var: example \ No newline at end of file + var: example + family3: # The third family with space + var: example # A variable \ No newline at end of file diff --git a/tests/results/test_namespace_examples_comment/20_7help_family.md b/tests/results/test_namespace_examples_comment/20_7help_family.md index 8bb069a47..0e26027f8 100644 --- a/tests/results/test_namespace_examples_comment/20_7help_family.md +++ b/tests/results/test_namespace_examples_comment/20_7help_family.md @@ -7,6 +7,8 @@ rougail: # Rougail var: example family2: # The second family var: example + family3: # The third family with space + var: example # A variable ``` # Example with all modifiable variables @@ -18,4 +20,6 @@ rougail: # Rougail var: example family2: # The second family var: example + family3: # The third family with space + var: example # A variable ``` \ No newline at end of file diff --git a/tests/results/test_namespace_examples_comment/20_7help_family.sh b/tests/results/test_namespace_examples_comment/20_7help_family.sh index 12607cfdf..22cc4ff39 100644 --- a/tests/results/test_namespace_examples_comment/20_7help_family.sh +++ b/tests/results/test_namespace_examples_comment/20_7help_family.sh @@ -6,6 +6,8 @@  var: example   family2: # The second family   var: example  + family3: # The third family with space  + var: example # A variable  Example with all modifiable variables @@ -15,4 +17,6 @@  var: example   family2: # The second family   var: example  + family3: # The third family with space  + var: example # A variable  diff --git a/tests/results/test_namespace_without_family/00_7help.adoc b/tests/results/test_namespace_without_family/00_7help.adoc index c2c2c87c4..0ed3f6ef7 100644 --- a/tests/results/test_namespace_without_family/00_7help.adoc +++ b/tests/results/test_namespace_without_family/00_7help.adoc @@ -12,5 +12,12 @@ With useful information. `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The second variable. + Multi line Help +With useful information. +| **rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The third variable with spaces. + +Multi line with space. + +Help. + With useful information. |==== \ No newline at end of file diff --git a/tests/results/test_namespace_without_family/00_7help.changelog.adoc b/tests/results/test_namespace_without_family/00_7help.changelog.adoc index 15ebdf9cf..86620a694 100644 --- a/tests/results/test_namespace_without_family/00_7help.changelog.adoc +++ b/tests/results/test_namespace_without_family/00_7help.changelog.adoc @@ -14,5 +14,12 @@ With useful information. `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The second variable. + Multi line Help +With useful information. +| **rougail.var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The third variable with spaces. + +Multi line with space. + +Help. + With useful information. |==== \ No newline at end of file diff --git a/tests/results/test_namespace_without_family/00_7help.changelog.gitlab.md b/tests/results/test_namespace_without_family/00_7help.changelog.gitlab.md index a1a79f2ed..b1be6431c 100644 --- a/tests/results/test_namespace_without_family/00_7help.changelog.gitlab.md +++ b/tests/results/test_namespace_without_family/00_7help.changelog.gitlab.md @@ -1,8 +1,9 @@
New variables -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| Variable | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.
Multi line with space.

Help.

With useful information. |
\ No newline at end of file diff --git a/tests/results/test_namespace_without_family/00_7help.changelog.html b/tests/results/test_namespace_without_family/00_7help.changelog.html index cff1a96ff..4755d113b 100644 --- a/tests/results/test_namespace_without_family/00_7help.changelog.html +++ b/tests/results/test_namespace_without_family/00_7help.changelog.html @@ -12,6 +12,11 @@ Help With useful information. rougail.var2
string basic mandatoryThe second variable.
Multi line Help +With useful information. +rougail.var3
string basic mandatoryThe third variable with spaces.
Multi line with space. + +Help. + With useful information. \ No newline at end of file diff --git a/tests/results/test_namespace_without_family/00_7help.changelog.md b/tests/results/test_namespace_without_family/00_7help.changelog.md index cba095de7..1b3a13b69 100644 --- a/tests/results/test_namespace_without_family/00_7help.changelog.md +++ b/tests/results/test_namespace_without_family/00_7help.changelog.md @@ -1,6 +1,7 @@ # New variables -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | \ No newline at end of file +| Variable | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.
Multi line with space.

Help.

With useful information. | \ No newline at end of file diff --git a/tests/results/test_namespace_without_family/00_7help.changelog.sh b/tests/results/test_namespace_without_family/00_7help.changelog.sh index f8a86a7cb..c24a953d0 100644 --- a/tests/results/test_namespace_without_family/00_7help.changelog.sh +++ b/tests/results/test_namespace_without_family/00_7help.changelog.sh @@ -14,5 +14,12 @@ โ”‚  string   basic   mandatory  โ”‚ Multi line โ”‚ โ”‚ โ”‚ Help โ”‚ โ”‚ โ”‚ With useful information. โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ rougail.var3 โ”‚ The third variable with spaces. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ Multi line with space. โ”‚ +โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ Help. โ”‚ +โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ With useful information. โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ diff --git a/tests/results/test_namespace_without_family/00_7help.gitlab.md b/tests/results/test_namespace_without_family/00_7help.gitlab.md index d2ba8e48a..70440e015 100644 --- a/tests/results/test_namespace_without_family/00_7help.gitlab.md +++ b/tests/results/test_namespace_without_family/00_7help.gitlab.md @@ -1,4 +1,5 @@ -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | \ No newline at end of file +| Variable | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.
Multi line with space.

Help.

With useful information. | \ No newline at end of file diff --git a/tests/results/test_namespace_without_family/00_7help.html b/tests/results/test_namespace_without_family/00_7help.html index cad876617..e96dc1744 100644 --- a/tests/results/test_namespace_without_family/00_7help.html +++ b/tests/results/test_namespace_without_family/00_7help.html @@ -10,6 +10,11 @@ Help With useful information. rougail.var2
string basic mandatoryThe second variable.
Multi line Help +With useful information. +rougail.var3
string basic mandatoryThe third variable with spaces.
Multi line with space. + +Help. + With useful information. \ No newline at end of file diff --git a/tests/results/test_namespace_without_family/00_7help.json b/tests/results/test_namespace_without_family/00_7help.json index 2de586c97..93c5ab6d9 100644 --- a/tests/results/test_namespace_without_family/00_7help.json +++ b/tests/results/test_namespace_without_family/00_7help.json @@ -49,6 +49,25 @@ "mode": "basic", "type": "variable", "variable_type": "string" + }, + "var3": { + "path": "rougail.var3", + "name": "var3", + "description": "The third variable with spaces.", + "help": [ + "Multi line with space.\n \nHelp.\n\nWith useful information." + ], + "properties": [ + { + "type": "property", + "name": "mandatory", + "ori_name": "mandatory", + "access_control": false + } + ], + "mode": "basic", + "type": "variable", + "variable_type": "string" } } } diff --git a/tests/results/test_namespace_without_family/00_7help.md b/tests/results/test_namespace_without_family/00_7help.md index d2ba8e48a..70440e015 100644 --- a/tests/results/test_namespace_without_family/00_7help.md +++ b/tests/results/test_namespace_without_family/00_7help.md @@ -1,4 +1,5 @@ -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | -| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | \ No newline at end of file +| Variable | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| **rougail.var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | +| **rougail.var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| **rougail.var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.
Multi line with space.

Help.

With useful information. | \ No newline at end of file diff --git a/tests/results/test_namespace_without_family/00_7help.sh b/tests/results/test_namespace_without_family/00_7help.sh index dd23372a3..a212d00a9 100644 --- a/tests/results/test_namespace_without_family/00_7help.sh +++ b/tests/results/test_namespace_without_family/00_7help.sh @@ -12,5 +12,12 @@ โ”‚  string   basic   mandatory  โ”‚ Multi line โ”‚ โ”‚ โ”‚ Help โ”‚ โ”‚ โ”‚ With useful information. โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ rougail.var3 โ”‚ The third variable with spaces. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ Multi line with space. โ”‚ +โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ Help. โ”‚ +โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ With useful information. โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ diff --git a/tests/results/test_namespace_without_family/20_7help_family.adoc b/tests/results/test_namespace_without_family/20_7help_family.adoc index ee8c782b6..3a6365cc5 100644 --- a/tests/results/test_namespace_without_family/20_7help_family.adoc +++ b/tests/results/test_namespace_without_family/20_7help_family.adoc @@ -1,8 +1,10 @@ [cols="1a,1a"] |==== -| Variable +| Variable | Description | **rougail.family1.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | | **rougail.family2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +| **rougail.family3.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | A variable. |==== \ No newline at end of file diff --git a/tests/results/test_namespace_without_family/20_7help_family.changelog.adoc b/tests/results/test_namespace_without_family/20_7help_family.changelog.adoc index 3b8f20edd..d8fc3dfb7 100644 --- a/tests/results/test_namespace_without_family/20_7help_family.changelog.adoc +++ b/tests/results/test_namespace_without_family/20_7help_family.changelog.adoc @@ -2,9 +2,11 @@ [cols="1a,1a"] |==== -| Variable +| Variable | Description | **rougail.family1.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | | **rougail.family2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +| **rougail.family3.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | A variable. |==== \ No newline at end of file diff --git a/tests/results/test_namespace_without_family/20_7help_family.changelog.gitlab.md b/tests/results/test_namespace_without_family/20_7help_family.changelog.gitlab.md index da10ac9c1..556fa717c 100644 --- a/tests/results/test_namespace_without_family/20_7help_family.changelog.gitlab.md +++ b/tests/results/test_namespace_without_family/20_7help_family.changelog.gitlab.md @@ -1,8 +1,9 @@
New variables -| Variable | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | -| **rougail.family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **rougail.family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **rougail.family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **rougail.family3.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. |
\ No newline at end of file diff --git a/tests/results/test_namespace_without_family/20_7help_family.changelog.html b/tests/results/test_namespace_without_family/20_7help_family.changelog.html index 348a6a7a5..f3da1c287 100644 --- a/tests/results/test_namespace_without_family/20_7help_family.changelog.html +++ b/tests/results/test_namespace_without_family/20_7help_family.changelog.html @@ -2,10 +2,11 @@ - + - - + + +
Variable
Variable Description
rougail.family1.var
string basic mandatory
rougail.family2.var
string basic mandatory
rougail.family1.var
string basic mandatory
rougail.family2.var
string basic mandatory
rougail.family3.var
string basic mandatory
A variable.
\ No newline at end of file diff --git a/tests/results/test_namespace_without_family/20_7help_family.changelog.md b/tests/results/test_namespace_without_family/20_7help_family.changelog.md index d9fabbbc1..41a44af4e 100644 --- a/tests/results/test_namespace_without_family/20_7help_family.changelog.md +++ b/tests/results/test_namespace_without_family/20_7help_family.changelog.md @@ -1,6 +1,7 @@ # New variables -| Variable | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | -| **rougail.family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | \ No newline at end of file +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **rougail.family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **rougail.family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **rougail.family3.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | \ No newline at end of file diff --git a/tests/results/test_namespace_without_family/20_7help_family.changelog.sh b/tests/results/test_namespace_without_family/20_7help_family.changelog.sh index eeaed59f1..fb9da80c6 100644 --- a/tests/results/test_namespace_without_family/20_7help_family.changelog.sh +++ b/tests/results/test_namespace_without_family/20_7help_family.changelog.sh @@ -1,12 +1,15 @@ New variables -โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ -โ”ƒ Variable  โ”ƒ -โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ -โ”‚ rougail.family1.var โ”‚ -โ”‚  string   basic   mandatory  โ”‚ -โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค -โ”‚ rougail.family2.var โ”‚ -โ”‚  string   basic   mandatory  โ”‚ -โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ +โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ +โ”ƒ Variable  โ”ƒ Description  โ”ƒ +โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ +โ”‚ rougail.family1.var โ”‚ โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ rougail.family2.var โ”‚ โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ rougail.family3.var โ”‚ A variable. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ diff --git a/tests/results/test_namespace_without_family/20_7help_family.gitlab.md b/tests/results/test_namespace_without_family/20_7help_family.gitlab.md index c5a95718a..bca60492d 100644 --- a/tests/results/test_namespace_without_family/20_7help_family.gitlab.md +++ b/tests/results/test_namespace_without_family/20_7help_family.gitlab.md @@ -1,4 +1,5 @@ -| Variable | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | -| **rougail.family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | \ No newline at end of file +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **rougail.family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **rougail.family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **rougail.family3.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | \ No newline at end of file diff --git a/tests/results/test_namespace_without_family/20_7help_family.html b/tests/results/test_namespace_without_family/20_7help_family.html index bf328d2f4..6ff126d00 100644 --- a/tests/results/test_namespace_without_family/20_7help_family.html +++ b/tests/results/test_namespace_without_family/20_7help_family.html @@ -1,9 +1,10 @@ - + - - + + +
Variable
Variable Description
rougail.family1.var
string basic mandatory
rougail.family2.var
string basic mandatory
rougail.family1.var
string basic mandatory
rougail.family2.var
string basic mandatory
rougail.family3.var
string basic mandatory
A variable.
\ No newline at end of file diff --git a/tests/results/test_namespace_without_family/20_7help_family.json b/tests/results/test_namespace_without_family/20_7help_family.json index 9769591f9..b0ec13c85 100644 --- a/tests/results/test_namespace_without_family/20_7help_family.json +++ b/tests/results/test_namespace_without_family/20_7help_family.json @@ -71,6 +71,37 @@ "variable_type": "string" } } + }, + "family3": { + "type": "family", + "informations": { + "path": "rougail.family3", + "name": "family3", + "description": "The third family with space", + "help": [ + "Multi line\n \nHelp\nWith useful information." + ], + "properties": [], + "mode": "basic" + }, + "children": { + "var": { + "path": "rougail.family3.var", + "name": "var", + "description": "A variable.", + "properties": [ + { + "type": "property", + "name": "mandatory", + "ori_name": "mandatory", + "access_control": false + } + ], + "mode": "basic", + "type": "variable", + "variable_type": "string" + } + } } } } diff --git a/tests/results/test_namespace_without_family/20_7help_family.md b/tests/results/test_namespace_without_family/20_7help_family.md index c5a95718a..bca60492d 100644 --- a/tests/results/test_namespace_without_family/20_7help_family.md +++ b/tests/results/test_namespace_without_family/20_7help_family.md @@ -1,4 +1,5 @@ -| Variable | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **rougail.family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | -| **rougail.family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | \ No newline at end of file +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **rougail.family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **rougail.family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **rougail.family3.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | \ No newline at end of file diff --git a/tests/results/test_namespace_without_family/20_7help_family.sh b/tests/results/test_namespace_without_family/20_7help_family.sh index ef4e9df22..fdf5d8695 100644 --- a/tests/results/test_namespace_without_family/20_7help_family.sh +++ b/tests/results/test_namespace_without_family/20_7help_family.sh @@ -1,10 +1,13 @@ -โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ -โ”ƒ Variable  โ”ƒ -โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ -โ”‚ rougail.family1.var โ”‚ -โ”‚  string   basic   mandatory  โ”‚ -โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค -โ”‚ rougail.family2.var โ”‚ -โ”‚  string   basic   mandatory  โ”‚ -โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ +โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ +โ”ƒ Variable  โ”ƒ Description  โ”ƒ +โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ +โ”‚ rougail.family1.var โ”‚ โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ rougail.family2.var โ”‚ โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ rougail.family3.var โ”‚ A variable. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ diff --git a/tests/results/test_without_family/00_7help.adoc b/tests/results/test_without_family/00_7help.adoc index f85f2c803..7c6bd7c61 100644 --- a/tests/results/test_without_family/00_7help.adoc +++ b/tests/results/test_without_family/00_7help.adoc @@ -12,5 +12,12 @@ With useful information. `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The second variable. + Multi line Help +With useful information. +| **var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The third variable with spaces. + +Multi line with space. + +Help. + With useful information. |==== \ No newline at end of file diff --git a/tests/results/test_without_family/00_7help.changelog.adoc b/tests/results/test_without_family/00_7help.changelog.adoc index 12fcf5624..775edd27f 100644 --- a/tests/results/test_without_family/00_7help.changelog.adoc +++ b/tests/results/test_without_family/00_7help.changelog.adoc @@ -14,5 +14,12 @@ With useful information. `https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The second variable. + Multi line Help +With useful information. +| **var3** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | The third variable with spaces. + +Multi line with space. + +Help. + With useful information. |==== \ No newline at end of file diff --git a/tests/results/test_without_family/00_7help.changelog.gitlab.md b/tests/results/test_without_family/00_7help.changelog.gitlab.md index 541f3c8ab..b2f184ec6 100644 --- a/tests/results/test_without_family/00_7help.changelog.gitlab.md +++ b/tests/results/test_without_family/00_7help.changelog.gitlab.md @@ -1,8 +1,9 @@
New variables -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| Variable | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.
Multi line with space.

Help.

With useful information. |
\ No newline at end of file diff --git a/tests/results/test_without_family/00_7help.changelog.html b/tests/results/test_without_family/00_7help.changelog.html index fa269366d..eb6ae80fc 100644 --- a/tests/results/test_without_family/00_7help.changelog.html +++ b/tests/results/test_without_family/00_7help.changelog.html @@ -12,6 +12,11 @@ Help With useful information. var2
string basic mandatoryThe second variable.
Multi line Help +With useful information. +var3
string basic mandatoryThe third variable with spaces.
Multi line with space. + +Help. + With useful information. \ No newline at end of file diff --git a/tests/results/test_without_family/00_7help.changelog.md b/tests/results/test_without_family/00_7help.changelog.md index a6bdb49c0..215a66c2f 100644 --- a/tests/results/test_without_family/00_7help.changelog.md +++ b/tests/results/test_without_family/00_7help.changelog.md @@ -1,6 +1,7 @@ # New variables -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | \ No newline at end of file +| Variable | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.
Multi line with space.

Help.

With useful information. | \ No newline at end of file diff --git a/tests/results/test_without_family/00_7help.changelog.sh b/tests/results/test_without_family/00_7help.changelog.sh index 2ffef2a58..48cff3521 100644 --- a/tests/results/test_without_family/00_7help.changelog.sh +++ b/tests/results/test_without_family/00_7help.changelog.sh @@ -14,5 +14,12 @@ โ”‚  string   basic   mandatory  โ”‚ Multi line โ”‚ โ”‚ โ”‚ Help โ”‚ โ”‚ โ”‚ With useful information. โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ var3 โ”‚ The third variable with spaces. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ Multi line with space. โ”‚ +โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ Help. โ”‚ +โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ With useful information. โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ diff --git a/tests/results/test_without_family/00_7help.gitlab.md b/tests/results/test_without_family/00_7help.gitlab.md index 4264a12d3..ad7194b8d 100644 --- a/tests/results/test_without_family/00_7help.gitlab.md +++ b/tests/results/test_without_family/00_7help.gitlab.md @@ -1,4 +1,5 @@ -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | \ No newline at end of file +| Variable | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.
Multi line with space.

Help.

With useful information. | \ No newline at end of file diff --git a/tests/results/test_without_family/00_7help.html b/tests/results/test_without_family/00_7help.html index 2b265bd12..f11543e34 100644 --- a/tests/results/test_without_family/00_7help.html +++ b/tests/results/test_without_family/00_7help.html @@ -10,6 +10,11 @@ Help With useful information. var2
string basic mandatoryThe second variable.
Multi line Help +With useful information. +var3
string basic mandatoryThe third variable with spaces.
Multi line with space. + +Help. + With useful information. \ No newline at end of file diff --git a/tests/results/test_without_family/00_7help.json b/tests/results/test_without_family/00_7help.json index 0a573fe7c..2b98900a3 100644 --- a/tests/results/test_without_family/00_7help.json +++ b/tests/results/test_without_family/00_7help.json @@ -36,5 +36,24 @@ "mode": "basic", "type": "variable", "variable_type": "string" + }, + "var3": { + "path": "var3", + "name": "var3", + "description": "The third variable with spaces.", + "help": [ + "Multi line with space.\n \nHelp.\n\nWith useful information." + ], + "properties": [ + { + "type": "property", + "name": "mandatory", + "ori_name": "mandatory", + "access_control": false + } + ], + "mode": "basic", + "type": "variable", + "variable_type": "string" } } \ No newline at end of file diff --git a/tests/results/test_without_family/00_7help.md b/tests/results/test_without_family/00_7help.md index 4264a12d3..ad7194b8d 100644 --- a/tests/results/test_without_family/00_7help.md +++ b/tests/results/test_without_family/00_7help.md @@ -1,4 +1,5 @@ -| Variable | Description | -|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------| -| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | -| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | \ No newline at end of file +| Variable | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------| +| **var1**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The first variable.
Multi line

Help

With useful information. | +| **var2**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The second variable.
Multi line
Help
With useful information. | +| **var3**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | The third variable with spaces.
Multi line with space.

Help.

With useful information. | \ No newline at end of file diff --git a/tests/results/test_without_family/00_7help.sh b/tests/results/test_without_family/00_7help.sh index 2a2db7e5d..c5784dd94 100644 --- a/tests/results/test_without_family/00_7help.sh +++ b/tests/results/test_without_family/00_7help.sh @@ -12,5 +12,12 @@ โ”‚  string   basic   mandatory  โ”‚ Multi line โ”‚ โ”‚ โ”‚ Help โ”‚ โ”‚ โ”‚ With useful information. โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ var3 โ”‚ The third variable with spaces. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ Multi line with space. โ”‚ +โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ Help. โ”‚ +โ”‚ โ”‚ โ”‚ +โ”‚ โ”‚ With useful information. โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ diff --git a/tests/results/test_without_family/20_7help_family.adoc b/tests/results/test_without_family/20_7help_family.adoc index 50ff18f95..9fde08d29 100644 --- a/tests/results/test_without_family/20_7help_family.adoc +++ b/tests/results/test_without_family/20_7help_family.adoc @@ -1,8 +1,10 @@ [cols="1a,1a"] |==== -| Variable +| Variable | Description | **family1.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | | **family2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +| **family3.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | A variable. |==== \ No newline at end of file diff --git a/tests/results/test_without_family/20_7help_family.changelog.adoc b/tests/results/test_without_family/20_7help_family.changelog.adoc index 8db0af643..0a20bd8bc 100644 --- a/tests/results/test_without_family/20_7help_family.changelog.adoc +++ b/tests/results/test_without_family/20_7help_family.changelog.adoc @@ -2,9 +2,11 @@ [cols="1a,1a"] |==== -| Variable +| Variable | Description | **family1.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | | **family2.var** + -`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | +| **family3.var** + +`https://rougail.readthedocs.io/en/latest/variable.html#variables-types[string]` `basic` `mandatory` | A variable. |==== \ No newline at end of file diff --git a/tests/results/test_without_family/20_7help_family.changelog.gitlab.md b/tests/results/test_without_family/20_7help_family.changelog.gitlab.md index 5c7c43945..3d54133c7 100644 --- a/tests/results/test_without_family/20_7help_family.changelog.gitlab.md +++ b/tests/results/test_without_family/20_7help_family.changelog.gitlab.md @@ -1,8 +1,9 @@
New variables -| Variable | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | -| **family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **family3.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. |
\ No newline at end of file diff --git a/tests/results/test_without_family/20_7help_family.changelog.html b/tests/results/test_without_family/20_7help_family.changelog.html index 5203325d2..8815402f8 100644 --- a/tests/results/test_without_family/20_7help_family.changelog.html +++ b/tests/results/test_without_family/20_7help_family.changelog.html @@ -2,10 +2,11 @@ - + - - + + +
Variable
Variable Description
family1.var
string basic mandatory
family2.var
string basic mandatory
family1.var
string basic mandatory
family2.var
string basic mandatory
family3.var
string basic mandatory
A variable.
\ No newline at end of file diff --git a/tests/results/test_without_family/20_7help_family.changelog.md b/tests/results/test_without_family/20_7help_family.changelog.md index 2aca189c8..d0a9f33e5 100644 --- a/tests/results/test_without_family/20_7help_family.changelog.md +++ b/tests/results/test_without_family/20_7help_family.changelog.md @@ -1,6 +1,7 @@ # New variables -| Variable | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | -| **family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | \ No newline at end of file +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **family3.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | \ No newline at end of file diff --git a/tests/results/test_without_family/20_7help_family.changelog.sh b/tests/results/test_without_family/20_7help_family.changelog.sh index 5b91edf30..b1de62f83 100644 --- a/tests/results/test_without_family/20_7help_family.changelog.sh +++ b/tests/results/test_without_family/20_7help_family.changelog.sh @@ -1,12 +1,15 @@ New variables -โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ -โ”ƒ Variable  โ”ƒ -โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ -โ”‚ family1.var โ”‚ -โ”‚  string   basic   mandatory  โ”‚ -โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค -โ”‚ family2.var โ”‚ -โ”‚  string   basic   mandatory  โ”‚ -โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ +โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ +โ”ƒ Variable  โ”ƒ Description  โ”ƒ +โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ +โ”‚ family1.var โ”‚ โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ family2.var โ”‚ โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ family3.var โ”‚ A variable. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ diff --git a/tests/results/test_without_family/20_7help_family.gitlab.md b/tests/results/test_without_family/20_7help_family.gitlab.md index 279895d64..a578a3247 100644 --- a/tests/results/test_without_family/20_7help_family.gitlab.md +++ b/tests/results/test_without_family/20_7help_family.gitlab.md @@ -1,4 +1,5 @@ -| Variable | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | -| **family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | \ No newline at end of file +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **family3.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | \ No newline at end of file diff --git a/tests/results/test_without_family/20_7help_family.html b/tests/results/test_without_family/20_7help_family.html index 8aba177b4..5bdf1f83b 100644 --- a/tests/results/test_without_family/20_7help_family.html +++ b/tests/results/test_without_family/20_7help_family.html @@ -1,9 +1,10 @@ - + - - + + +
Variable
Variable Description
family1.var
string basic mandatory
family2.var
string basic mandatory
family1.var
string basic mandatory
family2.var
string basic mandatory
family3.var
string basic mandatory
A variable.
\ No newline at end of file diff --git a/tests/results/test_without_family/20_7help_family.json b/tests/results/test_without_family/20_7help_family.json index 52e6501fc..3e6f428ca 100644 --- a/tests/results/test_without_family/20_7help_family.json +++ b/tests/results/test_without_family/20_7help_family.json @@ -58,5 +58,36 @@ "variable_type": "string" } } + }, + "family3": { + "type": "family", + "informations": { + "path": "family3", + "name": "family3", + "description": "The third family with space", + "help": [ + "Multi line\n \nHelp\nWith useful information." + ], + "properties": [], + "mode": "basic" + }, + "children": { + "var": { + "path": "family3.var", + "name": "var", + "description": "A variable.", + "properties": [ + { + "type": "property", + "name": "mandatory", + "ori_name": "mandatory", + "access_control": false + } + ], + "mode": "basic", + "type": "variable", + "variable_type": "string" + } + } } } \ No newline at end of file diff --git a/tests/results/test_without_family/20_7help_family.md b/tests/results/test_without_family/20_7help_family.md index 279895d64..a578a3247 100644 --- a/tests/results/test_without_family/20_7help_family.md +++ b/tests/results/test_without_family/20_7help_family.md @@ -1,4 +1,5 @@ -| Variable | -|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | -| **family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | \ No newline at end of file +| Variable | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| **family1.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **family2.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | | +| **family3.var**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | A variable. | \ No newline at end of file diff --git a/tests/results/test_without_family/20_7help_family.sh b/tests/results/test_without_family/20_7help_family.sh index 0cb450e50..9430b28b1 100644 --- a/tests/results/test_without_family/20_7help_family.sh +++ b/tests/results/test_without_family/20_7help_family.sh @@ -1,10 +1,13 @@ -โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ -โ”ƒ Variable  โ”ƒ -โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ -โ”‚ family1.var โ”‚ -โ”‚  string   basic   mandatory  โ”‚ -โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค -โ”‚ family2.var โ”‚ -โ”‚  string   basic   mandatory  โ”‚ -โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ +โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“ +โ”ƒ Variable  โ”ƒ Description  โ”ƒ +โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ +โ”‚ family1.var โ”‚ โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ family2.var โ”‚ โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค +โ”‚ family3.var โ”‚ A variable. โ”‚ +โ”‚  string   basic   mandatory  โ”‚ โ”‚ +โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜