matplotlib
diff --git a/‎lib/matplotlib/artist.py
Copy file name to clipboardExpand all lines: lib/matplotlib/artist.py
+120-58Lines changed: 120 additions & 58 deletions b/‎lib/matplotlib/artist.py
Copy file name to clipboardExpand all lines: lib/matplotlib/artist.py
+120-58Lines changed: 120 additions & 58 deletions
@@ -302,10 +302,13 @@ def is_transform_set(self):
 
     def set_transform(self, t):
         """
-        Set the :class:`~matplotlib.transforms.Transform` instance
-        used by this artist.
+        Set the artist transform.
 
-        ACCEPTS: :class:`~matplotlib.transforms.Transform` instance
+        Parameters
+        ----------
+        t : `~.Transform`
+            ..
+                ACCEPTS: `~.Transform`
         """
         self._transform = t
         self._transformSet = True
@@ -373,7 +376,11 @@ def set_contains(self, picker):
         and *props* is a dictionary of properties you want returned
         with the contains test.
 
-        ACCEPTS: a callable function
+        Parameters
+        ----------
+        picker : callable
+            ..
+                ACCEPTS: a callable function
         """
         self._contains = picker
 
@@ -450,47 +457,52 @@ def set_picker(self, picker):
             artist, return *hit=True* and props is a dictionary of
             properties you want added to the PickEvent attributes.
 
-        ACCEPTS: [None|float|boolean|callable]
+        Parameters
+        ----------
+        picker : None or bool or float or callable
+            ..
+                ACCEPTS: [None | bool | float | callable]
         """
         self._picker = picker
 
     def get_picker(self):
-        'Return the picker object used by this artist'
+        """Return the picker object used by this artist."""
         return self._picker
 
     @cbook.deprecated("2.2", "artist.figure is not None")
     def is_figure_set(self):
-        """
-        Returns True if the artist is assigned to a
-        :class:`~matplotlib.figure.Figure`.
-        """
+        """Returns whether the artist is assigned to a `~.Figure`."""
         return self.figure is not None
 
     def get_url(self):
-        """
-        Returns the url
-        """
+        """Returns the url."""
         return self._url
 
     def set_url(self, url):
         """
-        Sets the url for the artist
+        Sets the url for the artist.
 
-        ACCEPTS: a url string
+        Parameters
+        ----------
+        url : str
+            ..
+                ACCEPTS: a url string
         """
         self._url = url
 
     def get_gid(self):
-        """
-        Returns the group id
-        """
+        """Returns the group id."""
         return self._gid
 
     def set_gid(self, gid):
         """
-        Sets the (group) id for the artist
+        Sets the (group) id for the artist.
 
-        ACCEPTS: an id string
+        Parameters
+        ----------
+        gid : str
+            ..
+                ACCEPTS: an id string
         """
         self._gid = gid
 
@@ -524,6 +536,12 @@ def set_snap(self, snap):
             segments, round to the nearest pixel center
 
         Only supported by the Agg and MacOSX backends.
+
+        Parameters
+        ----------
+        snap : bool or None
+            ..
+                ACCEPTS: bool or None
         """
         self._snap = snap
         self.stale = True
@@ -569,6 +587,9 @@ def set_sketch_params(self, scale=None, length=None, randomness=None):
         randomness : float, optional
             The scale factor by which the length is shrunken or
             expanded (default 16.0)
+
+            ..
+                ACCEPTS: (scale: float, length: float, randomness: float)
         """
         if scale is None:
             self._sketch = None
@@ -577,9 +598,13 @@ def set_sketch_params(self, scale=None, length=None, randomness=None):
         self.stale = True
 
     def set_path_effects(self, path_effects):
-        """
-        set path_effects, which should be a list of instances of
-        matplotlib.patheffect._Base class or its derivatives.
+        """Set the path effects.
+
+        Parameters
+        ----------
+        path_effects : `~.AbstractPathEffect`
+            ..
+                ACCEPTS: `~.AbstractPathEffect`
         """
         self._path_effects = path_effects
         self.stale = True
@@ -588,18 +613,18 @@ def get_path_effects(self):
         return self._path_effects
 
     def get_figure(self):
-        """
-        Return the :class:`~matplotlib.figure.Figure` instance the
-        artist belongs to.
-        """
+        """Return the `~.Figure` instance the artist belongs to."""
         return self.figure
 
     def set_figure(self, fig):
         """
-        Set the :class:`~matplotlib.figure.Figure` instance the artist
-        belongs to.
+        Set the `~.Figure` instance the artist belongs to.
 
-        ACCEPTS: a :class:`matplotlib.figure.Figure` instance
+        Parameters
+        ----------
+        fig : `~.Figure`
+            ..
+                ACCEPTS: a `~.Figure` instance
         """
         # if this is a no-op just return
         if self.figure is fig:
@@ -619,9 +644,13 @@ def set_figure(self, fig):
 
     def set_clip_box(self, clipbox):
         """
-        Set the artist's clip :class:`~matplotlib.transforms.Bbox`.
+        Set the artist's clip `~.Bbox`.
 
-        ACCEPTS: a :class:`matplotlib.transforms.Bbox` instance
+        Parameters
+        ----------
+        clipbox : `~.Bbox`
+            ..
+                ACCEPTS: a `~.Bbox` instance
         """
         self.clipbox = clipbox
         self.pchanged()
@@ -642,9 +671,7 @@ def set_clip_path(self, path, transform=None):
         this method will set the clipping box to the corresponding rectangle
         and set the clipping path to ``None``.
 
-        ACCEPTS: [ (:class:`~matplotlib.path.Path`,
-        :class:`~matplotlib.transforms.Transform`) |
-        :class:`~matplotlib.patches.Patch` | None ]
+        ACCEPTS: [(`~matplotlib.path.Path`, `~.Transform`) | `~.Patch` | None]
         """
         from matplotlib.patches import Patch, Rectangle
 
@@ -727,7 +754,11 @@ def set_clip_on(self, b):
         When False artists will be visible out side of the axes which
         can lead to unexpected results.
 
-        ACCEPTS: [True | False]
+        Parameters
+        ----------
+        b : bool
+            ..
+                ACCEPTS: bool
         """
         self._clipon = b
         # This may result in the callbacks being hit twice, but ensures they
@@ -746,30 +777,42 @@ def _set_gc_clip(self, gc):
             gc.set_clip_path(None)
 
     def get_rasterized(self):
-        "return True if the artist is to be rasterized"
+        """Return whether the artist is to be rasterized."""
         return self._rasterized
 
     def set_rasterized(self, rasterized):
         """
         Force rasterized (bitmap) drawing in vector backend output.
 
-        Defaults to None, which implies the backend's default behavior
+        Defaults to None, which implies the backend's default behavior.
 
-        ACCEPTS: [True | False | None]
+        Parameters
+        ----------
+        rasterized : bool or None
+            ..
+                ACCEPTS: bool or None
         """
         if rasterized and not hasattr(self.draw, "_supports_rasterization"):
             warnings.warn("Rasterization of '%s' will be ignored" % self)
 
         self._rasterized = rasterized
 
     def get_agg_filter(self):
-        "return filter function to be used for agg filter"
+        """Return filter function to be used for agg filter."""
         return self._agg_filter
 
     def set_agg_filter(self, filter_func):
-        """
-        set agg_filter function.
+        """Set the agg filter.
+
+        Parameters
+        ----------
+        filter_func : callable
+            A filter function, which takes a (m, n, 3) float array and a dpi
+            value, and returns a (m, n, 3) array.
 
+            ..
+                ACCEPTS: a filter function, which takes a (m, n, 3) float array
+                and a dpi value, and returns a (m, n, 3) array
         """
         self._agg_filter = filter_func
         self.stale = True
@@ -785,17 +828,25 @@ def set_alpha(self, alpha):
         Set the alpha value used for blending - not supported on
         all backends.
 
-        ACCEPTS: float (0.0 transparent through 1.0 opaque)
+        Parameters
+        ----------
+        alpha : float
+            ..
+                ACCEPTS: float (0.0 transparent through 1.0 opaque)
         """
         self._alpha = alpha
         self.pchanged()
         self.stale = True
 
     def set_visible(self, b):
         """
-        Set the artist's visiblity.
+        Set the artist's visibility.
 
-        ACCEPTS: [True | False]
+        Parameters
+        ----------
+        b : bool
+            ..
+                ACCEPTS: bool
         """
         self._visible = b
         self.pchanged()
@@ -805,26 +856,30 @@ def set_animated(self, b):
         """
         Set the artist's animation state.
 
-        ACCEPTS: [True | False]
+        Parameters
+        ----------
+        b : bool
+            ..
+                ACCEPTS: bool
         """
         if self._animated != b:
             self._animated = b
             self.pchanged()
 
     def update(self, props):
         """
-        Update the properties of this :class:`Artist` from the
-        dictionary *prop*.
+        Update this artist's properties from the dictionary *prop*.
         """
         def _update_property(self, k, v):
-            """sorting out how to update property (setter or setattr)
+            """Sorting out how to update property (setter or setattr).
 
             Parameters
             ----------
             k : str
                 The name of property to update
             v : obj
                 The value to assign to the property
+
             Returns
             -------
             ret : obj or None
@@ -855,36 +910,43 @@ def _update_property(self, k, v):
         return ret
 
     def get_label(self):
-        """
-        Get the label used for this artist in the legend.
-        """
+        """Get the label used for this artist in the legend."""
         return self._label
 
     def set_label(self, s):
         """
         Set the label to *s* for auto legend.
 
-        ACCEPTS: string or anything printable with '%s' conversion.
+        Parameters
+        ----------
+        s : object
+            *s* will be converted to a string by calling `str` (`unicode` on
+            Py2).
+
+            ..
+                ACCEPTS: object
         """
         if s is not None:
-            self._label = '%s' % (s, )
+            self._label = six.text_type(s)
         else:
             self._label = None
         self.pchanged()
         self.stale = True
 
     def get_zorder(self):
-        """
-        Return the :class:`Artist`'s zorder.
-        """
+        """Return the artist's zorder."""
         return self.zorder
 
     def set_zorder(self, level):
         """
         Set the zorder for the artist.  Artists with lower zorder
         values are drawn first.
 
-        ACCEPTS: any number
+        Parameters
+        ----------
+        level : float
+            ..
+                ACCEPTS: float
         """
         self.zorder = level
         self.pchanged()