We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent fcff6b6 commit dc5ed5fCopy full SHA for dc5ed5f
doc/development.rst
@@ -69,6 +69,8 @@ We use `Sphinx <https://www.sphinx-doc.org/>`_ to generate the documentation.
69
The documentation is written in `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_.
70
71
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.
74
75
To build the documentation, run:
76
0 commit comments