Deprecate Artist.is_figure_set.

anntzer · anntzer · commit e01750163797 · 2017-11-06T11:53:43.000-08:00
Implicit boolean conversion of artist.figure works just as well.
diff --git a/doc/api/artist_api.rst b/doc/api/artist_api.rst
@@ -44,7 +44,6 @@ Interactive
    Artist.set_picker
    Artist.contains
 
-
 Margins and Autoscaling
 -----------------------
 
@@ -80,7 +79,6 @@ Bulk Properties
    Artist.properties
    Artist.set
 
-
 Drawing
 -------
 
@@ -114,8 +112,6 @@ Drawing
    Artist.get_path_effects
    Artist.get_transformed_clip_path_and_affine
 
-
-
 Figure and Axes
 ---------------
 
@@ -129,7 +125,6 @@ Figure and Axes
 
    Artist.set_figure
    Artist.get_figure
-   Artist.is_figure_set
 
 Children
 --------
@@ -141,7 +136,6 @@ Children
    Artist.get_children
    Artist.findobj
 
-
 Transform
 ---------
 
@@ -153,8 +147,6 @@ Transform
    Artist.get_transform
    Artist.is_transform_set
 
-
-
 Units
 -----
 
diff --git a/doc/api/axes_api.rst b/doc/api/axes_api.rst
@@ -619,7 +619,6 @@ Artist Methods
    :template: autosummary.rst
    :nosignatures:
 
-   Axes.is_figure_set
    Axes.remove
    Axes.is_transform_set
 
diff --git a/doc/api/axis_api.rst b/doc/api/axis_api.rst
@@ -503,7 +503,6 @@ Ticks
    Tick.get_zorder
    Tick.have_units
    Tick.hitlist
-   Tick.is_figure_set
    Tick.is_transform_set
    Tick.mouseover
    Tick.pchanged
@@ -571,7 +570,6 @@ Ticks
    XTick.get_zorder
    XTick.have_units
    XTick.hitlist
-   XTick.is_figure_set
    XTick.is_transform_set
    XTick.mouseover
    XTick.pchanged
@@ -639,7 +637,6 @@ Ticks
    YTick.get_zorder
    YTick.have_units
    YTick.hitlist
-   YTick.is_figure_set
    YTick.is_transform_set
    YTick.mouseover
    YTick.pchanged
@@ -717,7 +714,6 @@ Axis
    Axis.get_zorder
    Axis.have_units
    Axis.hitlist
-   Axis.is_figure_set
    Axis.is_transform_set
    Axis.mouseover
    Axis.pchanged
@@ -785,7 +781,6 @@ Axis
    XAxis.get_zorder
    XAxis.have_units
    XAxis.hitlist
-   XAxis.is_figure_set
    XAxis.is_transform_set
    XAxis.mouseover
    XAxis.pchanged
@@ -853,7 +848,6 @@ Axis
    YAxis.get_zorder
    YAxis.have_units
    YAxis.hitlist
-   YAxis.is_figure_set
    YAxis.is_transform_set
    YAxis.mouseover
    YAxis.pchanged
diff --git a/lib/matplotlib/artist.py b/lib/matplotlib/artist.py
@@ -458,6 +458,7 @@ def get_picker(self):
         '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
