We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent fa82d96 commit a625f76Copy full SHA for a625f76
1 file changed
docs/document/sphinx/docstrings.rst
@@ -141,6 +141,28 @@ NumPy Style Guide:
141
"""
142
return True
143
144
+.. tip::
145
+ You can have your docstring syntax checked using the following :doc:`ruff
146
+ <Python4DataScience:productive/qa/ruff>` configuration:
147
+
148
+ .. code-block:: toml
149
+ :caption: pyproject.toml
150
151
+ [tool.ruff]
152
+ lint.pydocstyle.convention = "google"
153
154
+ or:
155
156
157
158
159
160
+ lint.pydocstyle.convention = "numpy"
161
162
+ .. seealso::
163
+ * `lint.pydocstyle.convention
164
+ <https://docs.astral.sh/ruff/settings/#lint_pydocstyle_convention>`_
165
166
.. note::
167
We also frequently use the NumPy Style Guide in agent-based software
168
development:
0 commit comments