[tutorial 022] A variable in "shorthand" mode (config and doc)
This commit is contained in:
parent
a1d82f1d56
commit
b4c0913830
1 changed files with 10 additions and 5 deletions
15
README.md
15
README.md
|
@ -23,6 +23,7 @@ include_toc: true
|
|||
- [[tutorial 018] Family in "shorthand" mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_018/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_018~1..v1.1_018))
|
||||
- [[tutorial 020] A boolean variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_020/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_020~1..v1.1_020))
|
||||
- [[tutorial 021] Bases type is optional if default value](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_021/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_021~1..v1.1_021))
|
||||
- [[tutorial 022] A variable in "shorthand" mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_022/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_022~1..v1.1_022))
|
||||
|
||||
|
||||
# Description
|
||||
|
@ -30,9 +31,15 @@ include_toc: true
|
|||
|
||||
<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
|
||||
|
||||
Bases type is optional if default value
|
||||
A variable in "shorthand" mode
|
||||
|
||||
The type is deduct with the default value type. This is only true for "string", "number", "float" or "boolean" variables.
|
||||
Transform it in "shorthand" mode.
|
||||
|
||||
In this notation we can only define:
|
||||
|
||||
- name
|
||||
- default value (so deduct the type)
|
||||
- description
|
||||
|
||||
# Structure
|
||||
|
||||
|
@ -85,9 +92,7 @@ manual:
|
|||
---
|
||||
manual:
|
||||
|
||||
use_for_https:
|
||||
description: Also use this proxy for HTTPS
|
||||
default: true
|
||||
use_for_https: true # Also use this proxy for HTTPS
|
||||
|
||||
```
|
||||
## Generated documentation
|
||||
|
|
Loading…
Reference in a new issue