From 01e92c97b82b35c330ae7e4926a26699e8bc0c3e Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sat, 2 Nov 2024 14:58:13 +0100 Subject: [PATCH] [tutorial 012] A default value (config and doc) --- README.md | 40 ++++++++++++++++++++++++++-------------- config/01/output_ro.html | 11 ++++++++--- config/02/output_ro.html | 2 +- config/03/output_ro.html | 2 +- config/04/output_ro.html | 2 +- config/05/output_ro.html | 12 +++++++++--- 6 files changed, 46 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 1aa714c..c84de44 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) -- [[tutorial 010] A first variable with only a name](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010)) +- [[tutorial 011] The variable description](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_011/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011)) -# [tutorial 011] The variable description +# [tutorial 012] A default value -[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011) +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_012~1..v1.1_012) ## Screenshot @@ -22,6 +22,7 @@ --- proxy_mode: description: Configure Proxy Access to the Internet + default: No proxy ``` ### Generated documentation @@ -33,7 +34,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github | Variable                                                                                        | Description                                                                                     | |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. | +| **proxy_mode**
[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.
**Default**: No proxy | ## User data @@ -52,9 +53,14 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github ```console foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml ``` -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - proxy_mode (Configure Proxy Access to the Internet)
+
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: No proxy
 

 ### Example 2
 
@@ -78,7 +84,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml
 │ Unmodifiable variable                                       │
 ╰─────────────────────────────────────────────────────────────╯
 Variables:
-┗━━ 📓 proxy_mode: No proxy
+┗━━ 📓 proxy_mode: No proxy (No proxy)
### Example 3 @@ -102,7 +108,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml │ Unmodifiable variable │ ╰─────────────────────────────────────────────────────────────╯ Variables: -┗━━ 📓 proxy_mode: Manual proxy configuration +┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy) ### Example 4 @@ -126,7 +132,7 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml │ Unmodifiable variable │ ╰─────────────────────────────────────────────────────────────╯ Variables: -┗━━ 📓 proxy_mode: foo +┗━━ 📓 proxy_mode: foo (No proxy) ### Example 5 @@ -144,10 +150,16 @@ proxy_mode: 1 foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml ``` 
🛑 ERRORS
-┣━━ "1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
-┣━━ The following variables are mandatory but have no value:
-┗━━   - proxy_mode (Configure Proxy Access to the Internet)
+┗━━ "1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
+╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: No proxy
-- [[tutorial 012] A default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_012/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_012~1..v1.1_012)) +- [[tutorial 013] A variable with type "choice"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_013/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_013~1..v1.1_013)) diff --git a/config/01/output_ro.html b/config/01/output_ro.html index cebaee7..cdecbe8 100644 --- a/config/01/output_ro.html +++ b/config/01/output_ro.html @@ -1,4 +1,9 @@ -
🛑 ERRORS
-┣━━ The following variables are mandatory but have no value:
-┗━━   - proxy_mode (Configure Proxy Access to the Internet)
+
╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: No proxy
 

diff --git a/config/02/output_ro.html b/config/02/output_ro.html
index cee8799..38b2d86 100644
--- a/config/02/output_ro.html
+++ b/config/02/output_ro.html
@@ -5,5 +5,5 @@
 │ Unmodifiable variable                                       │
 ╰─────────────────────────────────────────────────────────────╯
 Variables:
-┗━━ 📓 proxy_mode: No proxy
+┗━━ 📓 proxy_mode: No proxy (No proxy)
diff --git a/config/03/output_ro.html b/config/03/output_ro.html index ea33c96..675192d 100644 --- a/config/03/output_ro.html +++ b/config/03/output_ro.html @@ -5,5 +5,5 @@ │ Unmodifiable variable │ ╰─────────────────────────────────────────────────────────────╯ Variables: -┗━━ 📓 proxy_mode: Manual proxy configuration +┗━━ 📓 proxy_mode: Manual proxy configuration (No proxy) diff --git a/config/04/output_ro.html b/config/04/output_ro.html index ce659f3..55d31f3 100644 --- a/config/04/output_ro.html +++ b/config/04/output_ro.html @@ -5,5 +5,5 @@ │ Unmodifiable variable │ ╰─────────────────────────────────────────────────────────────╯ Variables: -┗━━ 📓 proxy_mode: foo +┗━━ 📓 proxy_mode: foo (No proxy) diff --git a/config/05/output_ro.html b/config/05/output_ro.html index ae251c2..bf39385 100644 --- a/config/05/output_ro.html +++ b/config/05/output_ro.html @@ -1,5 +1,11 @@ 
🛑 ERRORS
-┣━━ "1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
-┣━━ The following variables are mandatory but have no value:
-┗━━   - proxy_mode (Configure Proxy Access to the Internet)
+┗━━ "1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
+╭────────────────────────── Caption ──────────────────────────╮
+│ Variable                           Default value            │
+│ Undocumented variable              Modified value           │
+│ Undocumented but modified variable (Original default value) │
+│ Unmodifiable variable                                       │
+╰─────────────────────────────────────────────────────────────╯
+Variables:
+┗━━ 📓 proxy_mode: No proxy