Merge pull request #20485 from sappelhoff/fix/docstr/hexbin

QuLogic · web-flow · commit 6f92db0fc6aa · 2021-06-23T05:37:02.000-04:00
DOC: hexbin 'extent' must be 4-tuple of float, not float
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -4647,17 +4647,16 @@ def hexbin(self, x, y, C=None, gridsize=100, bins=None,
             colormapped rectangles along the bottom of the x-axis and
             left of the y-axis.
 
-        extent : float, default: *None*
-            The limits of the bins. The default assigns the limits
-            based on *gridsize*, *x*, *y*, *xscale* and *yscale*.
+        extent : 4-tuple of float, default: *None*
+            The limits of the bins (xmin, xmax, ymin, ymax).
+            The default assigns the limits based on
+            *gridsize*, *x*, *y*, *xscale* and *yscale*.
 
             If *xscale* or *yscale* is set to 'log', the limits are
             expected to be the exponent for a power of 10. E.g. for
             x-limits of 1 and 50 in 'linear' scale and y-limits
             of 10 and 1000 in 'log' scale, enter (1, 50, 1, 3).
 
-            Order of scalars is (left, right, bottom, top).
-
         Returns
         -------
         `~matplotlib.collections.PolyCollection`
