Skip to content

Commit

Permalink
Update doc/development/development.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
h-mayorquin authored Sep 12, 2024
1 parent bc946a2 commit ee854b6
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/development/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/SpikeInterface/spikeinterface/issues/3019>`_):
Expand Down

0 comments on commit ee854b6

Please sign in to comment.