Merge pull request #13010 from timhoffm/fix-documenting-format

dstansby · web-flow · commit 22649b6e8d72 · 2018-12-18T11:29:50.000Z
Fix a format error in documenting_mpl.rst
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -475,7 +475,9 @@ also`` sections. No need to use backticks there::
 Wrapping parameter lists
 ~~~~~~~~~~~~~~~~~~~~~~~~
 Long parameter lists should be wrapped using a ``\`` for continuation and
-starting on the new line without any indent:
+starting on the new line without any indent (no indent because pydoc will
+parse the docstring and strip the line continuation so that indent would
+result in a lot of whitespace within the line):
 
 .. code-block:: python
 
@@ -485,8 +487,7 @@ starting on the new line without any indent:
 
       Parameters
       ----------
-      projection :
-          {'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', \
+      projection : {'aitoff', 'hammer', 'lambert', 'mollweide', 'polar', \
   'rectilinear'}, optional
           The projection type of the axes.
 
