Skip to content

Commit dc46a2e

Browse files
committed
Add stylistic convention for docs titles
1 parent 76fa01e commit dc46a2e

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

doc/development/development.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,7 @@ Miscelleaneous Stylistic Conventions
192192
#. Avoid using abbreviations in variable names (e.g. use :code:`recording` instead of :code:`rec`). It is especially important to avoid single letter variables.
193193
#. 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)
194194
#. We use file_path and folder_path (instead of file_name and folder_name) for clarity.
195+
#. For the titles of documentation pages, only capitalize the first letter of the first word and classes or software packages. For example, "How to use a SortingAnalyzer in SpikeInterface".
195196
#. For creating headers to divide sections of code we use the following convention (see issue `#3019 <https://github.com/SpikeInterface/spikeinterface/issues/3019>`_):
196197

197198

0 commit comments

Comments
 (0)