Merge pull request #14228 from phobson/axis-docstring

timhoffm · web-flow · commit ec99332974bf · 2019-05-16T23:25:10.000+02:00
DOC: fix parameters line in Axes.axis docstring
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -1628,7 +1628,7 @@ def axis(self, *args, **kwargs):
 
         Parameters
         ----------
-        xmin, ymin, xmax, ymax : float, optional
+        xmin, xmax, ymin, ymax : float, optional
             The axis limits to be set. Either none or all of the limits must
             be given. This can also be achieved using ::
 
diff --git a/lib/matplotlib/tests/test_axes.py b/lib/matplotlib/tests/test_axes.py
@@ -6449,6 +6449,22 @@ def test_axis_bool_arguments(fig_test, fig_ref):
     fig_ref.add_subplot(212).axis("on")
 
 
+def test_axis_extent_arg():
+    fig, ax = plt.subplots()
+    xmin = 5
+    xmax = 10
+    ymin = 15
+    ymax = 20
+    extent = ax.axis([xmin, xmax, ymin, ymax])
+
+    # test that the docstring is correct
+    assert tuple(extent) == (xmin, xmax, ymin, ymax)
+
+    # test that limits were set per the docstring
+    assert (xmin, xmax) == ax.get_xlim()
+    assert (ymin, ymax) == ax.get_ylim()
+
+
 def test_datetime_masked():
     # make sure that all-masked data falls back to the viewlim
     # set in convert.axisinfo....
