Merge pull request #17193 from timhoffm/doc-quote

anntzer · web-flow · commit 005c7a67bd99 · 2020-04-19T20:56:08.000+02:00
Document docstring quote convention
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -407,6 +407,22 @@ The basic docstring conventions are covered in the `numpydoc docstring guide`_
 and the Sphinx_ documentation.  Some Matplotlib-specific formatting conventions
 to keep in mind:
 
+Quote positions
+~~~~~~~~~~~~~~~
+The quotes for single line docstrings are on the same line (pydocstyle D200)::
+
+    def get_linewidth(self):
+        """Return the line width in points."""
+
+The quotes for multi-line docstrings are on separate lines (pydocstyle D213)::
+
+        def set_linestyle(self, ls):
+        """
+        Set the linestyle of the line.
+
+        [...]
+        """
+
 Function arguments
 ~~~~~~~~~~~~~~~~~~
 Function arguments and keywords within docstrings should be referred to
