docs(file-naming): file naming policy reference
This commit is contained in:
parent
d6dcc712fb
commit
bc509a6fcf
2 changed files with 16 additions and 3 deletions
|
|
@ -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 `<name>` 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.
|
||||
|
|
|
|||
|
|
@ -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 <src/branch/1.1>`,
|
||||
this workshop page corresponds to the tags :tutorial:`1.1_130 <src/tag/1.1_130/README.md>` to :tutorial:`1.1_132 <src/tag/1.1_132/README.md>`
|
||||
this workshop page corresponds to the tags :tutorial:`1.1_130 <src/tag/1.1_130/README.md>` to :tutorial:`1.1_131 <src/tag/1.1_131/README.md>`
|
||||
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 <namingconvention>`
|
||||
- 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 <filenamingconvention>`
|
||||
- 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".
|
||||
|
|
|
|||
Loading…
Reference in a new issue