Merge pull request #11938 from timhoffm/doc-line2d-part2

NelleV · web-flow · commit b47fd636ac64 · 2018-08-26T09:28:21.000-07:00
More docstring cleanup of Line2D.
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -828,7 +828,17 @@ def set_agg_filter(self, filter_func):
         self.stale = True
 
     def draw(self, renderer, *args, **kwargs):
-        'Derived classes drawing method'
+        """
+        Draw the Artist using the given renderer.
+
+        This method will be overridden in the Artist subclasses. Typically,
+        it is implemented to not have any effect if the Artist is not visible
+        (`.Artist.get_visible` is *False*).
+
+        Parameters
+        ----------
+        renderer : `.RendererBase` subclass.
+        """
         if not self.get_visible():
             return
         self.stale = False
diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -436,11 +436,18 @@ def contains(self, mouseevent):
         :meth:`~matplotlib.lines.Line2D.set_pickradius` to view or
         modify it.
 
-        Returns *True* if any values are within the radius along with
-        ``{'ind': pointlist}``, where *pointlist* is the set of points
-        within the radius.
+        Parameters
+        ----------
+        mouseevent : `matplotlib.backend_bases.MouseEvent`.
 
-        TODO: sort returned indices by distance
+        Returns
+        -------
+        contains : bool
+            Whether any values are within the radius.
+        ``{'ind': pointlist}``
+            Where *pointlist* is the set of points within the radius.
+
+            TODO: sort returned indices by distance
         """
         if callable(self._contains):
             return self._contains(self, mouseevent)
@@ -492,12 +499,18 @@ def contains(self, mouseevent):
         return len(ind) > 0, dict(ind=ind)
 
     def get_pickradius(self):
-        """Return the pick radius used for containment tests."""
+        """
+        Return the pick radius used for containment tests.
+
+        See `.contains` for more details.
+        """
         return self.pickradius
 
     def set_pickradius(self, d):
         """Set the pick radius used for containment tests.
 
+        See `.contains` for more details.
+
         Parameters
         ----------
         d : float
@@ -507,7 +520,9 @@ def set_pickradius(self, d):
 
     def get_fillstyle(self):
         """
-        Return the marker fillstyle.
+        Return the marker fill style.
+
+        See also `~.Line2D.set_fillstyle`.
         """
         return self._marker.get_fillstyle()
 
@@ -585,7 +600,11 @@ def set_markevery(self, every):
         self._markevery = every
 
     def get_markevery(self):
-        """Return the markevery setting."""
+        """
+        Return the markevery setting for marker subsampling.
+
+        See also `~.Line2D.set_markevery`.
+        """
         return self._markevery
 
     def set_picker(self, p):
@@ -715,7 +734,7 @@ def set_transform(self, t):
 
         Parameters
         ----------
-        t : matplotlib.transforms.Transform
+        t : `matplotlib.transforms.Transform`
         """
         Artist.set_transform(self, t)
         self._invalidx = True
@@ -729,7 +748,8 @@ def _is_sorted(self, x):
 
     @allow_rasterization
     def draw(self, renderer):
-        """Draw the Line with *renderer* unless visibility is *False*."""
+        # docstring inherited from Artist.draw.
+
         if not self.get_visible():
             return
 
@@ -864,22 +884,51 @@ def get_antialiased(self):
         return self._antialiased
 
     def get_color(self):
-        """Return the line color."""
+        """
+        Return the line color.
+
+        See also `~.Line2D.set_color`.
+        """
         return self._color
 
     def get_drawstyle(self):
+        """
+        Return the drawstyle.
+
+        See also `~.Line2D.set_drawstyle`.
+        """
         return self._drawstyle
 
     def get_linestyle(self):
+        """
+        Return the linestyle.
+
+        See also `~.Line2D.set_linestyle`.
+        """
         return self._linestyle
 
     def get_linewidth(self):
+        """
+        Return the linewidth in points.
+
+        See also `~.Line2D.set_linewidth`.
+        """
         return self._linewidth
 
     def get_marker(self):
+        """
+        Return the line marker.
+
+        See also `~.Line2D.set_marker`.
+        """
         return self._marker.get_marker()
 
     def get_markeredgecolor(self):
+        """
+        Return the marker edge color.
+
+        See also `~.Line2D.set_markeredgecolor`.
+        """
         mec = self._markeredgecolor
         if cbook._str_equal(mec, 'auto'):
             if rcParams['_internal.classic_mode']:
@@ -892,6 +941,11 @@ def get_markeredgecolor(self):
             return mec
 
     def get_markeredgewidth(self):
+        """
+        Return the marker edge width in points.
+
+        See also `~.Line2D.set_markeredgewidth`.
+        """
         return self._markeredgewidth
 
     def _get_markerfacecolor(self, alt=False):
@@ -905,12 +959,27 @@ def _get_markerfacecolor(self, alt=False):
             return fc
 
     def get_markerfacecolor(self):
+        """
+        Return the marker face color.
+
+        See also `~.Line2D.set_markerfacecolor`.
+        """
         return self._get_markerfacecolor(alt=False)
 
     def get_markerfacecoloralt(self):
+        """
+        Return the alternate marker face color.
+
+        See also `~.Line2D.set_markerfacecoloralt`.
+        """
         return self._get_markerfacecolor(alt=True)
 
     def get_markersize(self):
+        """
+        Return the marker size in points.
+
+        See also `~.Line2D.set_markersize`.
+        """
         return self._markersize
 
     def get_data(self, orig=True):
@@ -1252,7 +1321,7 @@ def set_dashes(self, seq):
             self.set_linestyle((0, seq))
 
     def update_from(self, other):
-        """copy properties from other to self"""
+        """Copy properties from other to self."""
         Artist.update_from(self, other)
         self._linestyle = other._linestyle
         self._linewidth = other._linewidth
@@ -1278,7 +1347,7 @@ def update_from(self, other):
 
     def set_dash_joinstyle(self, s):
         """
-        Set the join style for dashed linestyles.
+        Set the join style for dashed lines.
 
         Parameters
         ----------
@@ -1295,7 +1364,7 @@ def set_dash_joinstyle(self, s):
 
     def set_solid_joinstyle(self, s):
         """
-        Set the join style for solid linestyles.
+        Set the join style for solid lines.
 
         Parameters
         ----------
@@ -1313,19 +1382,23 @@ def set_solid_joinstyle(self, s):
 
     def get_dash_joinstyle(self):
         """
-        Get the join style for dashed linestyles.
+        Return the join style for dashed lines.
+
+        See also `~.Line2D.set_dash_joinstyle`.
         """
         return self._dashjoinstyle
 
     def get_solid_joinstyle(self):
         """
-        Get the join style for solid linestyles.
+        Return the join style for solid lines.
+
+        See also `~.Line2D.set_solid_joinstyle`.
         """
         return self._solidjoinstyle
 
     def set_dash_capstyle(self, s):
         """
-        Set the cap style for dashed linestyles.
+        Set the cap style for dashed lines.
 
         Parameters
         ----------
@@ -1341,7 +1414,7 @@ def set_dash_capstyle(self, s):
 
     def set_solid_capstyle(self, s):
         """
-        Set the cap style for solid linestyles.
+        Set the cap style for solid lines.
 
         Parameters
         ----------
@@ -1357,18 +1430,26 @@ def set_solid_capstyle(self, s):
 
     def get_dash_capstyle(self):
         """
-        Get the cap style for dashed linestyles.
+        Return the cap style for dashed lines.
+
+        See also `~.Line2D.set_dash_capstyle`.
         """
         return self._dashcapstyle
 
     def get_solid_capstyle(self):
         """
-        Get the cap style for solid linestyles.
+        Return the cap style for solid lines.
+
+        See also `~.Line2D.set_solid_capstyle`.
         """
         return self._solidcapstyle
 
     def is_dashed(self):
-        """Return whether line is dashstyle."""
+        """
+        Return whether line has a dashed linestyle.
+
+        See also `~.Line2D.set_linestyle`.
+        """
         return self._linestyle in ('--', '-.', ':')
 
 
