Merge pull request matplotlib#17125 from anntzer/multidoc

QuLogic · web-flow · commit 717d1fa3e51e · 2020-04-14T01:25:47.000-04:00
Make multiline docstrings start with a newline.
diff --git a/.flake8 b/.flake8
@@ -13,7 +13,7 @@ ignore =
     N801, N802, N803, N806, N812,
     # pydocstyle
     D100, D101, D102, D103, D104, D105, D106, D107,
-    D200, D202, D203, D204, D205, D207, D212, D213,
+    D200, D202, D203, D204, D205, D207, D212,
     D301
     D400, D401, D402, D403, D413,
 
diff --git a/lib/matplotlib/animation.py b/lib/matplotlib/animation.py
@@ -93,9 +93,9 @@ def correct_roundoff(x, dpi, n):
     return correct_roundoff(wnew, dpi, n), correct_roundoff(hnew, dpi, n)
 
 
-# A registry for available MovieWriter classes
 class MovieWriterRegistry:
     """Registry of available writer classes by human readable name."""
+
     def __init__(self):
         self._registered = dict()
 
@@ -104,7 +104,8 @@ def set_dirty(self):
         """Sets a flag to re-setup the writers."""
 
     def register(self, name):
-        """Decorator for registering a class under a name.
+        """
+        Decorator for registering a class under a name.
 
         Example use::
 
@@ -564,7 +565,8 @@ def finish(self):
 # Base class of ffmpeg information. Has the config keys and the common set
 # of arguments that controls the *output* side of things.
 class FFMpegBase:
-    """Mixin class for FFMpeg output.
+    """
+    Mixin class for FFMpeg output.
 
     To be useful this must be multiply-inherited from with a
     `MovieWriterBase` sub-class.
@@ -606,7 +608,8 @@ def isAvailable(cls):
 # Combine FFMpeg options with pipe-based writing
 @writers.register('ffmpeg')
 class FFMpegWriter(FFMpegBase, MovieWriter):
-    """Pipe-based ffmpeg writer.
+    """
+    Pipe-based ffmpeg writer.
 
     Frames are streamed directly to ffmpeg via a pipe and written in a single
     pass.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -669,7 +669,8 @@ def set_sketch_params(self, scale=None, length=None, randomness=None):
         self.stale = True
 
     def set_path_effects(self, path_effects):
-        """Set the path effects.
+        """
+        Set the path effects.
 
         Parameters
         ----------
@@ -883,7 +884,8 @@ def get_agg_filter(self):
         return self._agg_filter
 
     def set_agg_filter(self, filter_func):
-        """Set the agg filter.
+        """
+        Set the agg filter.
 
         Parameters
         ----------
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -7834,7 +7834,8 @@ def _kde_method(X, coords):
 
     def violin(self, vpstats, positions=None, vert=True, widths=0.5,
                showmeans=False, showextrema=True, showmedians=False):
-        """Drawing function for violin plots.
+        """
+        Drawing function for violin plots.
 
         Draw a violin plot for each column of *vpstats*. Each filled area
         extends to represent the entire data range, with optional lines at the
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -3022,7 +3022,8 @@ def locator_params(self, axis='both', tight=None, **kwargs):
                                      scalex=update_x, scaley=update_y)
 
     def tick_params(self, axis='both', **kwargs):
-        """Change the appearance of ticks, tick labels, and gridlines.
+        """
+        Change the appearance of ticks, tick labels, and gridlines.
 
         Tick properties that are not explicitly set using the keyword
         arguments remain unchanged unless *reset* is True.
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -1885,8 +1885,7 @@ def __init__(self, *args, **kwargs):
         self.offset_text_position = 'bottom'
 
     def contains(self, mouseevent):
-        """Test whether the mouse event occurred in the x axis.
-        """
+        """Test whether the mouse event occurred in the x axis."""
         inside, info = self._default_contains(mouseevent)
         if inside is not None:
             return inside, info
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -116,7 +116,8 @@ def get_registered_canvas_class(format):
 
 
 class RendererBase:
-    """An abstract base class to handle drawing/rendering operations.
+    """
+    An abstract base class to handle drawing/rendering operations.
 
     The following methods must be implemented in the backend for full
     functionality (though just implementing :meth:`draw_path` alone would
diff --git a/lib/matplotlib/backends/_backend_tk.py b/lib/matplotlib/backends/_backend_tk.py
@@ -260,7 +260,9 @@ def idle_draw(*args):
         self._idle_callback = self._tkcanvas.after_idle(idle_draw)
 
     def get_tk_widget(self):
-        """Return the Tk widget used to implement FigureCanvasTkAgg.
+        """
+        Return the Tk widget used to implement FigureCanvasTkAgg.
+
         Although the initial implementation uses a Tk canvas,  this routine
         is intended to hide that fact.
         """
diff --git a/lib/matplotlib/backends/backend_gtk3agg.py b/lib/matplotlib/backends/backend_gtk3agg.py
@@ -24,8 +24,7 @@ def _render_figure(self, width, height):
         backend_agg.FigureCanvasAgg.draw(self)
 
     def on_draw_event(self, widget, ctx):
-        """GtkDrawable draw event, like expose_event in GTK 2.X.
-        """
+        """GtkDrawable draw event, like expose_event in GTK 2.X."""
         allocation = self.get_allocation()
         w, h = allocation.width, allocation.height
 
diff --git a/lib/matplotlib/backends/backend_pdf.py b/lib/matplotlib/backends/backend_pdf.py
@@ -226,7 +226,9 @@ def pdfRepr(obj):
 
 
 class Reference:
-    """PDF reference object.
+    """
+    PDF reference object.
+
     Use PdfFile.reserveObject() to create References.
     """
 
@@ -1223,7 +1225,8 @@ def alphaState(self, alpha):
         return name
 
     def _soft_mask_state(self, smask):
-        """Return an ExtGState that sets the soft mask to the given shading.
+        """
+        Return an ExtGState that sets the soft mask to the given shading.
 
         Parameters
         ----------
@@ -1345,7 +1348,8 @@ def writeHatches(self):
         self.writeObject(self.hatchObject, hatchDict)
 
     def addGouraudTriangles(self, points, colors):
-        """Add a Gouraud triangle shading
+        """
+        Add a Gouraud triangle shading.
 
         Parameters
         ----------
@@ -1603,11 +1607,12 @@ def writePath(self, path, transform, clip=False, sketch=None):
         self.output(*cmds)
 
     def reserveObject(self, name=''):
-        """Reserve an ID for an indirect object.
+        """
+        Reserve an ID for an indirect object.
+
         The name is used for debugging in case we forget to print out
         the object with writeObject.
         """
-
         id = next(self._object_seq)
         self.xrefTable.append([None, 0, name])
         return Reference(id)
diff --git a/lib/matplotlib/backends/backend_qt5.py b/lib/matplotlib/backends/backend_qt5.py
@@ -293,14 +293,14 @@ def leaveEvent(self, event):
         FigureCanvasBase.leave_notify_event(self, guiEvent=event)
 
     def mouseEventCoords(self, pos):
-        """Calculate mouse coordinates in physical pixels
+        """
+        Calculate mouse coordinates in physical pixels.
 
         Qt5 use logical pixels, but the figure is scaled to physical
-        pixels for rendering.   Transform to physical pixels so that
+        pixels for rendering.  Transform to physical pixels so that
         all of the down-stream transforms work as expected.
 
         Also, the origin is different and needs to be corrected.
-
         """
         dpi_ratio = self._dpi_ratio
         x = pos.x()
@@ -442,8 +442,7 @@ def stop_event_loop(self, event=None):
             self._event_loop.quit()
 
     def draw(self):
-        """Render the figure, and queue a request for a Qt draw.
-        """
+        """Render the figure, and queue a request for a Qt draw."""
         # The renderer draw is done here; delaying causes problems with code
         # that uses the result of the draw() to update plot elements.
         if self._is_drawing:
@@ -453,9 +452,8 @@ def draw(self):
         self.update()
 
     def draw_idle(self):
-        """Queue redraw of the Agg buffer and request Qt paintEvent.
-        """
-        # The Agg draw needs to be handled by the same thread matplotlib
+        """Queue redraw of the Agg buffer and request Qt paintEvent."""
+        # The Agg draw needs to be handled by the same thread Matplotlib
         # modifies the scene graph from. Post Agg draw request to the
         # current event loop in order to ensure thread affinity and to
         # accumulate multiple draw requests from event handling.
diff --git a/lib/matplotlib/backends/qt_editor/figureoptions.py b/lib/matplotlib/backends/qt_editor/figureoptions.py
@@ -75,7 +75,8 @@ def cmp_key(label):
     curves = []
 
     def prepare_data(d, init):
-        """Prepare entry for FormLayout.
+        """
+        Prepare entry for FormLayout.
 
         *d* is a mapping of shorthands to style names (a single style may
         have multiple shorthands, in particular the shorthands `None`,
diff --git a/lib/matplotlib/cbook/__init__.py b/lib/matplotlib/cbook/__init__.py
@@ -165,8 +165,7 @@ def __getstate__(self):
         return {**vars(self), "callbacks": {}, "_func_cid_map": {}}
 
     def connect(self, s, func):
-        """Register *func* to be called when signal *s* is generated.
-        """
+        """Register *func* to be called when signal *s* is generated."""
         self._func_cid_map.setdefault(s, {})
         try:
             proxy = weakref.WeakMethod(func, self._remove_proxy)
@@ -197,8 +196,7 @@ def _remove_proxy(self, proxy, *, _is_finalizing=sys.is_finalizing):
                 del self._func_cid_map[signal]
 
     def disconnect(self, cid):
-        """Disconnect the callback registered with callback id *cid*.
-        """
+        """Disconnect the callback registered with callback id *cid*."""
         for eventname, callbackd in list(self.callbacks.items()):
             try:
                 del callbackd[cid]
diff --git a/lib/matplotlib/cm.py b/lib/matplotlib/cm.py
@@ -270,7 +270,8 @@ def to_rgba(self, x, alpha=None, bytes=False, norm=True):
         return rgba
 
     def set_array(self, A):
-        """Set the image array from numpy array *A*.
+        """
+        Set the image array from numpy array *A*.
 
         Parameters
         ----------
diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -462,8 +462,7 @@ def __init__(self, nrows, ncols,
                     artist=self)
 
     def get_subplot_params(self, figure=None):
-        """Return a dictionary of subplot layout parameters.
-        """
+        """Return a dictionary of subplot layout parameters."""
         hspace = (self._hspace if self._hspace is not None
                   else figure.subplotpars.hspace if figure is not None
                   else rcParams["figure.subplot.hspace"])
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -31,8 +31,7 @@
 
 
 def _get_dash_pattern(style):
-    """Convert linestyle -> dash pattern
-    """
+    """Convert linestyle to dash pattern."""
     # go from short hand -> full strings
     if isinstance(style, str):
         style = ls_mapper.get(style, style)
@@ -495,7 +494,8 @@ def get_pickradius(self):
         return self._pickradius
 
     def set_pickradius(self, d):
-        """Set the pick radius used for containment tests.
+        """
+        Set the pick radius used for containment tests.
 
         See `.contains` for more details.
 
diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -1065,7 +1065,8 @@ def silverman_factor(self):
     covariance_factor = scotts_factor
 
     def evaluate(self, points):
-        """Evaluate the estimated pdf on a set of points.
+        """
+        Evaluate the estimated pdf on a set of points.
 
         Parameters
         ----------
diff --git a/lib/matplotlib/patches.py b/lib/matplotlib/patches.py
@@ -470,7 +470,8 @@ def get_capstyle(self):
         return self._capstyle
 
     def set_joinstyle(self, s):
-        """Set the joinstyle.
+        """
+        Set the joinstyle.
 
         Parameters
         ----------
@@ -4207,7 +4208,8 @@ def __init__(self, xyA, xyB, coordsA, coordsB=None,
                  clip_on=False,
                  dpi_cor=1.,
                  **kwargs):
-        """Connect point *xyA* in *coordsA* with point *xyB* in *coordsB*
+        """
+        Connect point *xyA* in *coordsA* with point *xyB* in *coordsB*.
 
         Valid keys are
 
diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py
@@ -1258,7 +1258,8 @@ def get_rlabel_position(self):
         return np.rad2deg(self._r_label_position.get_matrix()[0, 2])
 
     def set_rlabel_position(self, value):
-        """Updates the theta position of the radius labels.
+        """
+        Updates the theta position of the radius labels.
 
         Parameters
         ----------
diff --git a/lib/matplotlib/streamplot.py b/lib/matplotlib/streamplot.py
@@ -246,7 +246,8 @@ def __init__(self, lines, arrows, **kwargs):
 # ========================
 
 class DomainMap:
-    """Map representing different coordinate systems.
+    """
+    Map representing different coordinate systems.
 
     Coordinate definitions:
 
@@ -361,7 +362,8 @@ def within_grid(self, xi, yi):
 
 
 class StreamMask:
-    """Mask to keep track of discrete regions crossed by streamlines.
+    """
+    Mask to keep track of discrete regions crossed by streamlines.
 
     The resolution of this grid determines the approximate spacing between
     trajectories. Streamlines are only allowed to pass through zeroed cells:
@@ -396,7 +398,8 @@ def _undo_trajectory(self):
             self._mask[t] = 0
 
     def _update_trajectory(self, xm, ym):
-        """Update current trajectory position in mask.
+        """
+        Update current trajectory position in mask.
 
         If the new position has already been filled, raise `InvalidIndexError`.
         """
@@ -446,7 +449,8 @@ def backward_time(xi, yi):
         return -dxi, -dyi
 
     def integrate(x0, y0):
-        """Return x, y grid-coordinates of trajectory based on starting point.
+        """
+        Return x, y grid-coordinates of trajectory based on starting point.
 
         Integrate both forward and backward in time from starting point in
         grid coordinates.
@@ -492,7 +496,8 @@ class OutOfBounds(IndexError):
 
 
 def _integrate_rk12(x0, y0, dmap, f, maxlength):
-    """2nd-order Runge-Kutta algorithm with adaptive step size.
+    """
+    2nd-order Runge-Kutta algorithm with adaptive step size.
 
     This method is also referred to as the improved Euler's method, or Heun's
     method. This method is favored over higher-order methods because:
@@ -658,7 +663,8 @@ def interpgrid(a, xi, yi):
 
 
 def _gen_starting_points(shape):
-    """Yield starting points for streamlines.
+    """
+    Yield starting points for streamlines.
 
     Trying points on the boundary first gives higher quality streamlines.
     This algorithm starts with a point on the mask corner and spirals inward.
diff --git a/lib/matplotlib/style/core.py b/lib/matplotlib/style/core.py
diff --git a/lib/matplotlib/testing/jpl_units/Duration.py b/lib/matplotlib/testing/jpl_units/Duration.py
diff --git a/lib/matplotlib/testing/jpl_units/Epoch.py b/lib/matplotlib/testing/jpl_units/Epoch.py
diff --git a/lib/matplotlib/testing/jpl_units/EpochConverter.py b/lib/matplotlib/testing/jpl_units/EpochConverter.py
diff --git a/lib/matplotlib/testing/jpl_units/StrConverter.py b/lib/matplotlib/testing/jpl_units/StrConverter.py
diff --git a/lib/matplotlib/testing/jpl_units/UnitDbl.py b/lib/matplotlib/testing/jpl_units/UnitDbl.py
diff --git a/lib/matplotlib/testing/jpl_units/UnitDblConverter.py b/lib/matplotlib/testing/jpl_units/UnitDblConverter.py
diff --git a/lib/matplotlib/tight_layout.py b/lib/matplotlib/tight_layout.py
diff --git a/lib/mpl_toolkits/axes_grid1/axes_rgb.py b/lib/mpl_toolkits/axes_grid1/axes_rgb.py
diff --git a/lib/mpl_toolkits/mplot3d/axes3d.py b/lib/mpl_toolkits/mplot3d/axes3d.py
