Skip to content

Commit dc5ed5f

Browse files
dweindldilpath
andcommitted
Update doc/development.rst
Co-authored-by: Dilan Pathirana <[email protected]>
1 parent fcff6b6 commit dc5ed5f

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

doc/development.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ We use `Sphinx <https://www.sphinx-doc.org/>`_ to generate the documentation.
6969
The documentation is written in `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_.
7070

7171
We use the `sphinx docstring-style <https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html>`__ for new code.
72+
The ``:param [ParamName]:`` and ``:return:`` statements are important when applicable.
73+
Manual type annotations (``:type [ParamName]:``) are redundant and should be avoided.
7274

7375
To build the documentation, run:
7476

0 commit comments

Comments
 (0)