From 01504bb24435ff4beb2aa975cb6454775343945f Mon Sep 17 00:00:00 2001 From: gwen Date: Wed, 10 Jun 2026 19:50:21 +0200 Subject: [PATCH] docs(fix): proofreading --- docs/abstract.rst | 4 ++-- docs/structured_data.rst | 6 ++++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/abstract.rst b/docs/abstract.rst index 2c8065a7b..3456e7899 100644 --- a/docs/abstract.rst +++ b/docs/abstract.rst @@ -189,7 +189,7 @@ Here we are talking about the variable lifecyle. The variable’s lifecyle is the period between its creation and its destruction. -The lifecycle of a variable includes the generic stages (like, in the C language): +The lifecycle of a variable includes the generic stages (for example, like in the C language): - Creation: variables are assigned a name and a type - Initialization: they are assigned their first value (we call it :term:`default value`) @@ -197,7 +197,7 @@ The lifecycle of a variable includes the generic stages (like, in the C language - Reading: the variable's value is used - Destruction: the variable terminates upon the destruction of the object -But not other concepts are included in the lifecycle, the access control, with properties describe access constraints. +.. note:: No other concept is included in the lifecycle (ni particular the access control, with properties describing access constraints). .. list-table:: :header-rows: 1 diff --git a/docs/structured_data.rst b/docs/structured_data.rst index d5ae0abc9..832228065 100644 --- a/docs/structured_data.rst +++ b/docs/structured_data.rst @@ -131,7 +131,7 @@ The structure file processing ---------------------------------- The :term:`structure files ` contain information that will be used by the consistency handling system for structure validation. -This is what we call :term:`structured data` writen in Rougail format. +This is what we call :term:`structured data` writen in :term:`Rougail format`. .. figure:: images/schema.png :alt: The Rougail process @@ -155,7 +155,9 @@ Once the structure files are loaded by Rougail, the :term:`Tiramisu` consistency A DSL stands for **Domain-Specific Language**, it is a programming or markup language designed for a specific application domain. Unlike general-purpose languages (like Python or Java), DSLs are optimized for a narrow set of problems, offering concise syntax and specialized features tailored to their domain. -Rougail format (or :term:`structured data`) is a DSL (Domain-Specific Language) designed for describing variables and their consistency. + Rougail format + + The Rougail format (or :term:`structured data`) is a DSL (Domain-Specific Language) designed for describing variables and their consistency. Declarative abstraction -----------------------