deprecate Legend.draggable in favor of Legend.set_draggable

timhoffm · timhoffm · commit 4d3f7eb1e9a7 · 2018-05-17T01:56:54.000+02:00
diff --git a/doc/api/api_changes/2017-12-20-TH.rst b/doc/api/api_changes/2017-12-20-TH.rst
@@ -0,0 +1,5 @@
+Deprecations
+````````````
+
+`.Legend.draggable()` is drepecated in favor of `.Legend.set_draggable()`.
+``Legend.draggable`` may be reintroduced as a property in future releases.
diff --git a/lib/matplotlib/backends/qt_editor/figureoptions.py b/lib/matplotlib/backends/qt_editor/figureoptions.py
@@ -242,7 +242,7 @@ def apply_callback(data):
                 ncol = old_legend._ncol
             new_legend = axes.legend(ncol=ncol)
             if new_legend:
-                new_legend.draggable(draggable)
+                new_legend.set_draggable(draggable)
 
         # Redraw
         figure = axes.get_figure()
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -31,7 +31,7 @@
 from matplotlib import rcParams
 from matplotlib import docstring
 from matplotlib.artist import Artist, allow_rasterization
-from matplotlib.cbook import silent_list, is_hashable
+from matplotlib.cbook import silent_list, is_hashable, warn_deprecated
 import matplotlib.colors as colors
 from matplotlib.font_manager import FontProperties
 from matplotlib.lines import Line2D
@@ -1155,6 +1155,12 @@ def draggable(self, state=None, use_blit=False, update="loc"):
         when dragged. If update is "loc", the *loc* parameter of the legend
         is changed. If "bbox", the *bbox_to_anchor* parameter is changed.
         """
+        warn_deprecated("2.2",
+                        message="Legend.draggable() is drepecated in "
+                                "favor of Legend.set_draggable(). "
+                                "Legend.draggable may be reintroduced as a "
+                                "property in future releases.")
+
         if state is None:
             state = not self.get_draggable()  # toggle state
 
