diff --git a/docs/index.rst b/docs/index.rst index 3b7675547..17f2c3c5f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/docs/tiramisu.rst b/docs/tiramisu.rst index 1d8eed786..79ccb7321 100644 --- a/docs/tiramisu.rst +++ b/docs/tiramisu.rst @@ -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. diff --git a/docs/tutorial/validators.rst b/docs/tutorial/validators.rst index e7d3726e9..5e211cd98 100644 --- a/docs/tutorial/validators.rst +++ b/docs/tutorial/validators.rst @@ -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):// - 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.