From bc509a6fcf366134b2c09adb26717fd83aaecd49 Mon Sep 17 00:00:00 2001 From: gwen Date: Sat, 30 May 2026 10:36:11 +0200 Subject: [PATCH] docs(file-naming): file naming policy reference --- docs/naming_convention.rst | 15 ++++++++++++++- docs/tutorial/practice1.rst | 4 ++-- 2 files changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/naming_convention.rst b/docs/naming_convention.rst index 3b0995e70..e6b1ac906 100644 --- a/docs/naming_convention.rst +++ b/docs/naming_convention.rst @@ -42,5 +42,18 @@ To facilitate classification, we have defined a standard notation for structure Where `XX` is a two digits integer followed by an hyphen, and `` is a name that describes the structure that is in this file. We advise you to adopt this convention as well. -Moreover, it is preferable to only use lowercase ASCII letters, numbers and the `"_"` (undescore) character. +.. _filenamingconvention: + +Generic file naming policy +--------------------------- + +Here are our generic file naming conventions. + +The regular expression that validates our file naming policy is: + +.. code-block:: python + + NAME_REGEXP = re.compile(r"^[a-z0-9_]*$") + +You can see that it is preferable to only use lowercase ASCII letters, numbers and the `"_"` (undescore) character. The snake case typographic convention is therefore used. diff --git a/docs/tutorial/practice1.rst b/docs/tutorial/practice1.rst index 7a654c4db..1ec78677a 100644 --- a/docs/tutorial/practice1.rst +++ b/docs/tutorial/practice1.rst @@ -35,7 +35,7 @@ These two variables are highlighted here in the lower part of the firefox config Of course, you can also decide to copy/paste or download the tutorial files contents while following the tutorial steps. If you want to follow this tutorial with the help of the corresponding :tutorial:`rougail-tutorials git repository `, - this workshop page corresponds to the tags :tutorial:`1.1_130 ` to :tutorial:`1.1_132 ` + this workshop page corresponds to the tags :tutorial:`1.1_130 ` to :tutorial:`1.1_131 ` in the repository. :: @@ -52,7 +52,7 @@ What do we want to be implemented .. exercise:: Exercice - choose a file name that respect the :ref:`file naming and organizing convention ` - - define an appropriate variable name # FIXME pas de convention pour le nom des familles/variables ? + - define an appropriate variable name, have a look at our :ref:`file naming convention ` - the Firefox description is in negative mode, which is not a good practice for us, we rewrite it in positive mode - the variable is a boolean with the default value `true` (the opposite of unchecked option) - the variable is available for all proxy mode choice by user, so disable it only when the `proxy mode` is "No proxy".