From 726fed06d0485dc708a6e1fc8605beeae5533a14 Mon Sep 17 00:00:00 2001 From: Heberto Mayorquin Date: Thu, 12 Sep 2024 09:38:42 -0600 Subject: [PATCH 1/5] 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 From 20fd07e8cdc0ec505a02fde1013f9edb0f9a47d2 Mon Sep 17 00:00:00 2001 From: Heberto Mayorquin Date: Thu, 12 Sep 2024 09:49:48 -0600 Subject: [PATCH 2/5] Update doc/development/development.rst Co-authored-by: Alessio Buccino --- doc/development/development.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/development/development.rst b/doc/development/development.rst index 792660d9aa..8d5471dc71 100644 --- a/doc/development/development.rst +++ b/doc/development/development.rst @@ -192,7 +192,7 @@ 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): +#. For creating headers to divide section of codes we use the following convention (see issue `#3019 `_): ######################################### # A header From bc946a259fa851bbcf892184969da569b71b8d24 Mon Sep 17 00:00:00 2001 From: Heberto Mayorquin Date: Thu, 12 Sep 2024 10:36:12 -0600 Subject: [PATCH 3/5] Update doc/development/development.rst Co-authored-by: Zach McKenzie <92116279+zm711@users.noreply.github.com> --- doc/development/development.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/development/development.rst b/doc/development/development.rst index 8d5471dc71..dd6886bb63 100644 --- a/doc/development/development.rst +++ b/doc/development/development.rst @@ -192,7 +192,7 @@ 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 `_): +#. For creating headers to divide sections of code we use the following convention (see issue `#3019 `_): ######################################### # A header From ee854b6ff0d589f9dd7c8552d65ebdfcf5426df8 Mon Sep 17 00:00:00 2001 From: Heberto Mayorquin Date: Thu, 12 Sep 2024 10:43:08 -0600 Subject: [PATCH 4/5] Update doc/development/development.rst --- doc/development/development.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/development/development.rst b/doc/development/development.rst index dd6886bb63..be94319fb4 100644 --- a/doc/development/development.rst +++ b/doc/development/development.rst @@ -189,7 +189,7 @@ so that the user knows what the options are. 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. +#. Avoid using abbreviations 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 sections of code we use the following convention (see issue `#3019 `_): From 67469ac1ce8706f684dbcc0ce08251b21c0ddb3b Mon Sep 17 00:00:00 2001 From: Heberto Mayorquin Date: Thu, 12 Sep 2024 11:48:43 -0600 Subject: [PATCH 5/5] Update doc/development/development.rst Co-authored-by: Alessio Buccino --- doc/development/development.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/doc/development/development.rst b/doc/development/development.rst index be94319fb4..246a2bcb9a 100644 --- a/doc/development/development.rst +++ b/doc/development/development.rst @@ -194,9 +194,12 @@ Miscelleaneous Stylistic Conventions #. We use file_path and folder_path (instead of file_name and folder_name) for clarity. #. For creating headers to divide sections of code we use the following convention (see issue `#3019 `_): -######################################### -# A header -######################################### + +.. code:: python + + ######################################### + # A header + ######################################### How to build the documentation