document use_blit

timhoffm · timhoffm · commit 3703788ec11a · 2018-05-17T01:56:54.000+02:00
diff --git a/doc/api/animation_api.rst b/doc/api/animation_api.rst
@@ -36,6 +36,9 @@ To save an animation to disk use `Animation.save` or `Animation.to_html5_video`
 See :ref:`ani_writer_classes` below for details about what movie formats are
 supported.
 
+
+.. _func-animation:
+
 ``FuncAnimation``
 -----------------
 
diff --git a/lib/matplotlib/legend.py b/lib/matplotlib/legend.py
@@ -59,8 +59,9 @@ def __init__(self, legend, use_blit=False, update="loc"):
         legend : `.Legend`
             The `.Legend` instance to wrap.
         use_blit : bool, optional
-
-        update : ['loc' | 'bbox'], optional
+            Use blitting for faster image composition. For details see
+            :ref:`func-animation`.
+        update : {'loc', 'bbox'}, optional
             If "loc", update the *loc* parameter of the legend upon finalizing.
             If "bbox", update the *bbox_to_anchor* parameter.
         """
@@ -1111,8 +1112,9 @@ def set_draggable(self, state, use_blit=False, update='loc'):
         state : bool
             ``True`` / ``False`` enables / disables mouse dragging.
         use_blit : bool, optional
-
-        update_loc : ['loc' | 'bbox'], optional
+            Use blitting for faster image composition. For details see
+            :ref:`func-animation`.
+        update : ['loc' | 'bbox'], optional
             The legend parameter to be changed when dragged:
 
             - 'loc': update the *loc* parameter of the legend
@@ -1132,6 +1134,7 @@ def set_draggable(self, state, use_blit=False, update='loc'):
             if self._draggable is not None:
                 self._draggable.disconnect()
             self._draggable = None
+        return self._draggable
 
     def get_draggable(self):
         """Return ``True`` if the legend is draggable, ``False`` otherwise."""
