Fix some docstring style issues.

anntzer · anntzer · commit e74a8bf1a2f8 · 2019-05-14T10:44:31.000+02:00
diff --git a/.flake8 b/.flake8
@@ -12,11 +12,9 @@ ignore =
     N801, N802, N803, N806, N812,
     # pydocstyle
     D100, D101, D102, D103, D104, D105, D106, D107,
-    D200, D202, D203, D204, D205, D207, D208, D209,
-    D210, D211, D212, D213, D214, D215,
-    D300, D301, D302,
-    D400, D401, D402, D403, D404, D405, D406, D407, D408, D409,
-    D410, D411, D412, D413, D414,
+    D200, D202, D203, D204, D205, D207, D208, D209, D212, D213,
+    D300, D301
+    D400, D401, D402, D403, D412, D413,
 
 exclude =
     .git
diff --git a/doc/sphinxext/gallery_order.py b/doc/sphinxext/gallery_order.py
@@ -27,7 +27,7 @@
 
 
 class MplExplicitOrder(ExplicitOrder):
-    """ for use within the 'subsection_order' key"""
+    """For use within the 'subsection_order' key."""
     def __call__(self, item):
         """Return a string determining the sort order."""
         if item in self.ordered_list:
@@ -65,7 +65,7 @@ def __call__(self, item):
 
 
 class MplExplicitSubOrder(object):
-    """ for use within the 'within_subsection_order' key """
+    """For use within the 'within_subsection_order' key."""
     def __init__(self, src_dir):
         self.src_dir = src_dir  # src_dir is unused here
         self.ordered_list = explicit_subsection_order
diff --git a/lib/matplotlib/__init__.py b/lib/matplotlib/__init__.py
@@ -705,12 +705,11 @@ def gen_candidates():
 
 
 class RcParams(MutableMapping, dict):
-
     """
-    A dictionary object including validation
+    A dictionary object including validation.
 
-    validating functions are defined and associated with rc parameters in
-    :mod:`matplotlib.rcsetup`
+    Validating functions are defined and associated with rc parameters in
+    :mod:`matplotlib.rcsetup`.
     """
 
     validate = {key: converter
diff --git a/lib/matplotlib/_layoutbox.py b/lib/matplotlib/_layoutbox.py
@@ -223,8 +223,7 @@ def soft_constraints(self):
             sol.addConstraint(i | 150000)
 
     def set_parent(self, parent):
-        ''' replace the parent of this with the new parent
-        '''
+        """Replace the parent of this with the new parent."""
         self.parent = parent
         self.parent_constrain()
 
@@ -378,14 +377,15 @@ def find_child_subplots(self):
 
     def layout_from_subplotspec(self, subspec,
                                 name='', artist=None, pos=False):
-        '''  Make a layout box from a subplotspec. The layout box is
+        """
+        Make a layout box from a subplotspec. The layout box is
         constrained to be a fraction of the width/height of the parent,
         and be a fraction of the parent width/height from the left/bottom
         of the parent.  Therefore the parent can move around and the
         layout for the subplot spec should move with it.
 
         The parent is *usually* the gridspec that made the subplotspec.??
-        '''
+        """
         lb = LayoutBox(parent=self, name=name, artist=artist, pos=pos)
         gs = subspec.get_gridspec()
         nrows, ncols = gs.get_geometry()
diff --git a/lib/matplotlib/backends/backend_qt5.py b/lib/matplotlib/backends/backend_qt5.py
@@ -674,7 +674,7 @@ class NavigationToolbar2QT(NavigationToolbar2, QtWidgets.QToolBar):
     message = QtCore.Signal(str)
 
     def __init__(self, canvas, parent, coordinates=True):
-        """ coordinates: should we show the coordinates on the right? """
+        """coordinates: should we show the coordinates on the right?"""
         self.canvas = canvas
         self.parent = parent
         self.coordinates = coordinates
diff --git a/lib/matplotlib/backends/backend_wx.py b/lib/matplotlib/backends/backend_wx.py
@@ -836,7 +836,7 @@ def _onKeyUp(self, evt):
             evt.Skip()
 
     def _set_capture(self, capture=True):
-        """control wx mouse capture """
+        """Control wx mouse capture."""
         if self.HasCapture():
             self.ReleaseMouse()
         if capture:
diff --git a/lib/matplotlib/bezier.py b/lib/matplotlib/bezier.py
@@ -98,7 +98,8 @@ def split_de_casteljau(beta, t):
 @cbook._rename_parameter("3.1", "tolerence", "tolerance")
 def find_bezier_t_intersecting_with_closedpath(
         bezier_point_at_t, inside_closedpath, t0=0., t1=1., tolerance=0.01):
-    """ Find a parameter t0 and t1 of the given bezier path which
+    """
+    Find a parameter t0 and t1 of the given bezier path which
     bounds the intersecting points with a provided closed
     path(*inside_closedpath*). Search starts from *t0* and *t1* and it
     uses a simple bisecting algorithm therefore one of the end point
@@ -223,8 +224,9 @@ def _f(r):
 
 @cbook._rename_parameter("3.1", "tolerence", "tolerance")
 def split_path_inout(path, inside, tolerance=0.01, reorder_inout=False):
-    """ divide a path into two segment at the point where inside(x, y)
-    becomes False.
+    """
+    Divide a path into two segments at the point where ``inside(x, y)`` becomes
+    False.
     """
 
     path_iter = path.iter_segments()
@@ -306,10 +308,9 @@ def get_cos_sin(x0, y0, x1, y1):
 
 @cbook._rename_parameter("3.1", "tolerence", "tolerance")
 def check_if_parallel(dx1, dy1, dx2, dy2, tolerance=1.e-5):
-    """ returns
-       * 1 if two lines are parallel in same direction
-       * -1 if two lines are parallel in opposite direction
-       * 0 otherwise
+    """
+    Return 1 if two lines are parallel in same direction, -1 if two lines are
+    parallel in opposite direction, 0 otherwise.
     """
     theta1 = np.arctan2(dx1, dy1)
     theta2 = np.arctan2(dx2, dy2)
diff --git a/lib/matplotlib/dates.py b/lib/matplotlib/dates.py
@@ -321,7 +321,7 @@ class strpdate2num(object):
     you know the date format string of the date you are parsing.
     """
     def __init__(self, fmt):
-        """ fmt: any valid strptime format is supported """
+        """fmt: any valid strptime format is supported"""
         self.fmt = fmt
 
     def __call__(self, s):
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -3572,7 +3572,7 @@ def test_empty_eventplot():
     ([[]], [[], [0, 1]], [[0, 1], []]),
     ('_empty', 'vertical', 'horizontal', None, 'none')))
 def test_eventplot_orientation(data, orientation):
-    """Introduced when fixing issue #6412. """
+    """Introduced when fixing issue #6412."""
     opts = {} if orientation == "_empty" else {'orientation': orientation}
     fig, ax = plt.subplots(1, 1)
     ax.eventplot(data, **opts)
@@ -5581,7 +5581,7 @@ def test_broken_barh_empty():
 
 
 def test_broken_barh_timedelta():
-    """Check that timedelta works as x, dx pair for this method """
+    """Check that timedelta works as x, dx pair for this method."""
     fig, ax = plt.subplots()
     pp = ax.broken_barh([(datetime.datetime(2018, 11, 9, 0, 0, 0),
                           datetime.timedelta(hours=1))], [1, 2])
diff --git a/lib/matplotlib/tests/test_constrainedlayout.py b/lib/matplotlib/tests/test_constrainedlayout.py
@@ -184,7 +184,7 @@ def test_constrained_layout10():
 @image_comparison(baseline_images=['constrained_layout11'],
         extensions=['png'])
 def test_constrained_layout11():
-    'Test for multiple nested gridspecs '
+    'Test for multiple nested gridspecs'
     fig = plt.figure(constrained_layout=True, figsize=(10, 3))
     gs0 = gridspec.GridSpec(1, 2, figure=fig)
     gsl = gridspec.GridSpecFromSubplotSpec(1, 2, gs0[0])
diff --git a/lib/matplotlib/tests/test_mlab.py b/lib/matplotlib/tests/test_mlab.py
@@ -1383,7 +1383,7 @@ def test_csd(self):
         assert spec.shape == freqs.shape
 
     def test_csd_padding(self):
-        """Test zero padding of csd(). """
+        """Test zero padding of csd()."""
         if self.NFFT_density is None:  # for derived classes
             return
         sargs = dict(x=self.y, y=self.y+1, Fs=self.Fs, window=mlab.window_none,
diff --git a/lib/matplotlib/tests/test_preprocess_data.py b/lib/matplotlib/tests/test_preprocess_data.py
@@ -75,7 +75,7 @@ def test_function_call_without_data(func):
 
 @pytest.mark.parametrize('func', all_funcs, ids=all_func_ids)
 def test_function_call_with_dict_data(func):
-    """Test with dict data -> label comes from the value of 'x' parameter """
+    """Test with dict data -> label comes from the value of 'x' parameter."""
     data = {"a": [1, 2], "b": [8, 9], "w": "NOT"}
     assert (func(None, "a", "b", data=data) ==
             "x: [1, 2], y: [8, 9], ls: x, w: xyz, label: b")
@@ -111,7 +111,7 @@ def test_function_call_with_dict_data_not_in_data(func):
 
 @pytest.mark.parametrize('func', all_funcs, ids=all_func_ids)
 def test_function_call_with_pandas_data(func, pd):
-    """test with pandas dataframe -> label comes from data["col"].name """
+    """Test with pandas dataframe -> label comes from ``data["col"].name``."""
     data = pd.DataFrame({"a": np.array([1, 2], dtype=np.int32),
                          "b": np.array([8, 9], dtype=np.int32),
                          "w": ["NOT", "NOT"]})
diff --git a/lib/mpl_toolkits/axisartist/grid_finder.py b/lib/mpl_toolkits/axisartist/grid_finder.py
@@ -37,9 +37,9 @@ def __call__(self, transform_xy, x1, y1, x2, y2):
         return self._add_pad(lon_min, lon_max, lat_min, lat_max)
 
     def _add_pad(self, lon_min, lon_max, lat_min, lat_max):
-        """ a small amount of padding is added because the current
-        clipping algorithms seems to fail when the gridline ends at
-        the bbox boundary.
+        """
+        A small amount of padding is added because the current clipping
+        algorithms seems to fail when the gridline ends at the bbox boundary.
         """
         dlon = (lon_max - lon_min) / self.nx
         dlat = (lat_max - lat_min) / self.ny
diff --git a/lib/mpl_toolkits/mplot3d/axis3d.py b/lib/mpl_toolkits/mplot3d/axis3d.py
@@ -46,7 +46,7 @@ def tick_update_position(tick, tickxs, tickys, labelpos):
 
 
 class Axis(maxis.XAxis):
-    """An Axis class for the 3D plots. """
+    """An Axis class for the 3D plots."""
     # These points from the unit cube make up the x, y and z-planes
     _PLANES = (
         (0, 3, 7, 4), (1, 2, 6, 5),     # yz planes
