Use None as sentinel value for ndivide.

jmehne · jmehne · commit 9f106188bca5 · 2016-03-19T16:44:09.000+01:00
diff --git a/doc/users/legend_guide.rst b/doc/users/legend_guide.rst
@@ -211,7 +211,7 @@ assign several legend keys to the same entry:
     p2, = plt.plot([3, 2, 1], 'k-o')
 
     l = plt.legend([(p1, p2)], ['Two keys'], numpoints=1,
-                   handler_map={tuple: HandlerTuple(ndivide=0)})
+                   handler_map={tuple: HandlerTuple(ndivide=None)})
 
 
 Implementing a custom legend handler
diff --git a/examples/pylab_examples/legend_demo6.py b/examples/pylab_examples/legend_demo6.py
@@ -16,7 +16,7 @@
 # and using a generic handler map (which would be used for any additional
 # tuples of handles like (p1, p3)).
 l = ax1.legend([(p1, p3), p2], ['two keys', 'one key'], scatterpoints=1,
-               numpoints=1, handler_map={tuple: HandlerTuple(ndivide=0)})
+               numpoints=1, handler_map={tuple: HandlerTuple(ndivide=None)})
 
 # Second plot: plot two bar charts on top of each other and change the padding
 # between the legend keys
@@ -29,7 +29,7 @@
 
 # Treat each legend entry differently by using specific `HandlerTuple`s
 l = ax2.legend([(rpos, rneg), (rneg, rpos)], ['pad!=0', 'pad=0'],
-               handler_map={(rpos, rneg): HandlerTuple(ndivide=0),
-                            (rneg, rpos): HandlerTuple(ndivide=0, pad=0.)})
+               handler_map={(rpos, rneg): HandlerTuple(ndivide=None),
+                            (rneg, rpos): HandlerTuple(ndivide=None, pad=0.)})
 
 plt.show()
diff --git a/lib/matplotlib/legend_handler.py b/lib/matplotlib/legend_handler.py
@@ -576,7 +576,7 @@ class HandlerTuple(HandlerBase):
     ----------
 
     ndivide : int, optional
-        The number of sections to divide the legend area into.  If 0,
+        The number of sections to divide the legend area into.  If None,
         use the length of the input tuple. Default is 1.
 
 
@@ -599,7 +599,7 @@ def create_artists(self, legend, orig_handle,
 
         handler_map = legend.get_legend_handler_map()
 
-        if self._ndivide == 0:
+        if self._ndivide is None:
             ndivide = len(orig_handle)
         else:
             ndivide = self._ndivide
diff --git a/lib/matplotlib/tests/test_legend.py b/lib/matplotlib/tests/test_legend.py
@@ -89,8 +89,8 @@ def test_multiple_keys():
     p3, = ax.plot([3, 4, 5], '-d')
     ax.legend([(p1, p2), (p2, p1), p3], ['two keys', 'pad=0', 'one key'],
               numpoints=1,
-              handler_map={(p1, p2): HandlerTuple(ndivide=0),
-                           (p2, p1): HandlerTuple(ndivide=0, pad=0)})
+              handler_map={(p1, p2): HandlerTuple(ndivide=None),
+                           (p2, p1): HandlerTuple(ndivide=None, pad=0)})
 
 
 @image_comparison(baseline_images=['rgba_alpha'],
