From 5746bdec26c8d0b29213f7844f5b7ccbdd1de020 Mon Sep 17 00:00:00 2001 From: chrishalcrow <57948917+chrishalcrow@users.noreply.github.com> Date: Tue, 4 Jun 2024 08:46:08 +0100 Subject: [PATCH] update development docs --- doc/development/development.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/development/development.rst b/doc/development/development.rst index 683a6807e9..1094b466fc 100644 --- a/doc/development/development.rst +++ b/doc/development/development.rst @@ -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: @@ -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 `_. +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.