From 726fed06d0485dc708a6e1fc8605beeae5533a14 Mon Sep 17 00:00:00 2001 From: Heberto Mayorquin Date: Thu, 12 Sep 2024 09:38:42 -0600 Subject: [PATCH] freeze decision --- doc/development/development.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/development/development.rst b/doc/development/development.rst index 1094b466fc..792660d9aa 100644 --- a/doc/development/development.rst +++ b/doc/development/development.rst @@ -192,6 +192,11 @@ Miscelleaneous Stylistic Conventions #. Avoid using abreviations in variable names (e.g., use :code:`recording` instead of :code:`rec`). It is especially important to avoid single letter variables. #. Use index as singular and indices for plural following the NumPy convention. Avoid idx or indexes. Plus, id and ids are reserved for identifiers (i.e. channel_ids) #. We use file_path and folder_path (instead of file_name and folder_name) for clarity. +#. For creating headers to divide section of codes we use the following convention (see issue 3019): + +######################################### +# A header +######################################### How to build the documentation