Skip to content

Commit

Permalink
update development docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrishalcrow committed Jun 4, 2024
1 parent a7e7678 commit 5746bde
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/development/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ for providing parameters, however is a little different. The project prefers the

.. code-block:: bash
parameter_name: type, default: default_value
parameter_name : type, default: default_value
This allows users to quickly understand the type of data that should be input into a function as well as whether a default is supplied. A full example would be:
Expand All @@ -179,7 +179,8 @@ This allows users to quickly understand the type of data that should be input in
"""
Note that in this example we demonstrate two other docstring conventions followed by SpikeInterface. First, that all string arguments should be presented
There should be a space between each parameter and the colon following it. This is neccessary for using the `numpydoc validator <https://numpydoc.readthedocs.io/en/latest/validation.html>`_.
In the above example we demonstrate two other docstring conventions followed by SpikeInterface. First, that all string arguments should be presented
with double quotes. This is the same stylistic convention followed by Black and enforced by the pre-commit for the repo. Second, when a parameter is a
string with a limited number of values (e.g. :code:`mean` and :code:`median`), rather than give the type a value of :code:`str`, please list the possible strings
so that the user knows what the options are.
Expand Down

0 comments on commit 5746bde

Please sign in to comment.