Merge pull request #6799 from anntzer/annotation-default-arrow

tacaswell · web-flow · commit 0fadaaf865cb · 2016-07-25T23:41:11.000-04:00
Allow creating annotation arrows w/ default props.
diff --git a/doc/users/whats_new/annotation-default-arrow.rst b/doc/users/whats_new/annotation-default-arrow.rst
@@ -0,0 +1,5 @@
+Annotation can use a default arrow style
+----------------------------------------
+
+Annotations now use the default arrow style when setting `arrowprops={}`,
+rather than no arrow (the new behavior actually matches the documentation).
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -183,6 +183,16 @@ def test_basic_annotate():
                 xytext=(3, 3), textcoords='offset points')
 
 
+@cleanup
+def test_annotate_default_arrow():
+    # Check that we can make an annotation arrow with only default properties.
+    fig, ax = plt.subplots()
+    ann = ax.annotate("foo", (0, 1), xytext=(2, 3))
+    assert ann.arrow_patch is None
+    ann = ax.annotate("foo", (0, 1), xytext=(2, 3), arrowprops={})
+    assert ann.arrow_patch is not None
+
+
 @image_comparison(baseline_images=['polar_axes'])
 def test_polar_annotations():
     # you can specify the xypoint and the xytext in different
diff --git a/lib/matplotlib/text.py b/lib/matplotlib/text.py
@@ -2151,7 +2151,7 @@ def __init__(self, s, xy,
 
         self.arrow = None
 
-        if arrowprops:
+        if arrowprops is not None:
             if "arrowstyle" in arrowprops:
                 arrowprops = self.arrowprops.copy()
                 self._arrow_relpos = arrowprops.pop("relpos", (0.5, 0.5))
@@ -2220,7 +2220,7 @@ def _update_position_xytext(self, renderer, xy_pixel):
         ox0, oy0 = self._get_xy_display()
         ox1, oy1 = xy_pixel
 
-        if self.arrowprops:
+        if self.arrowprops is not None:
             x0, y0 = xy_pixel
             l, b, w, h = Text.get_window_extent(self, renderer).bounds
             r = l + w
