stove/rougail
3
0
Fork 0
Code Issues 5 Pull requests 1 Projects Releases Wiki Activity

docs(Tiramisu): tiramisu page proofreading

Browse source
This commit is contained in:
gwen 2026-06-04 11:10:06 +02:00
parent f89fb5ac7f
commit 26b5d8dd10
3 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/index.rst
View file

@ -47,7 +47,6 @@ Rougail
:caption: What is it all about
concepts
tiramisu
tutorial/index
.. toctree::
@ -80,7 +79,8 @@ Rougail
configuration
cli
library/index
tiramisu
.. toctree::
:titlesonly:
:caption: Developper notes

2
docs/tiramisu.rst
View file

@ -1,7 +1,7 @@
Link between Rougail and Tiramisu
======================================
Is using Tiramisu?
Is Rougail using Tiramisu?
-------------------------------------
We have to say that the handling system used to ensure the variables integrity is another python library, called :term:`Tiramisu`. Rougail is currently strongly affiliated with Tiramisu.

7
docs/tutorial/validators.rst
View file

@ -27,21 +27,20 @@ Validating a variable's value
A variable with custom validation
-----------------------------------
First, we would like the :term:`operator` to remember not to forget the http protocol, that is to put `http://` at the beginning of our `web_address` variable's value.
Actually the `web_address`\ 's type requires that the address include the HTTP protocol, namely:
First, we would like the :term:`operator` to remember not to forget the HTTPS protocol, that is to put `https://` at the beginning of our `web_address` variable's value.
Actually the `web_address`\ 's variable existence *requires* that the address include the HTTPS protocol, namely:
::
http(s)://<domain_name><directory>
However, in our use case, we want *to force* the HTTPS protocol.
We don't want `http://`, only `https://`.
.. note:: This URL is for DNS over HTTPS, providing greater privacy than using the ISP's DNS,
which can filter traffic. If it uses `http://`, it doesn't make sense.
But there's no existing type for this specific use case (forcing HTTPS).
But there’s no existing type or types parameters for this specific use case (forcing HTTPS).
We just said that a valid value must start with `https://` instead of `http://`.
It is possible, instead of creating a new type, to add custom validation of the variable's value.