Skip to content

Commit bf0a355

Browse files
committed
adapt pyplot.xlim/ylim docstrings to set_x/ylim parameter naming
1 parent 77c90fa commit bf0a355

File tree

1 file changed

+16
-15
lines changed

1 file changed

+16
-15
lines changed

lib/matplotlib/pyplot.py

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1297,20 +1297,21 @@ def xlim(*args, **kwargs):
12971297
12981298
Call signatures::
12991299
1300-
xmin, xmax = xlim() # return the current xlim
1301-
xlim((xmin, xmax)) # set the xlim to xmin, xmax
1302-
xlim(xmin, xmax) # set the xlim to xmin, xmax
1300+
left, right = xlim() # return the current xlim
1301+
xlim((left, right)) # set the xlim to left, right
1302+
xlim(left, right) # set the xlim to left, right
13031303
1304-
If you do not specify args, you can pass *xmin* or *xmax* as kwargs, i.e.::
1304+
If you do not specify args, you can pass *left* or *right* as kwargs,
1305+
i.e.::
13051306
1306-
xlim(xmax=3) # adjust the max leaving min unchanged
1307-
xlim(xmin=1) # adjust the min leaving max unchanged
1307+
xlim(right=3) # adjust the right leaving left unchanged
1308+
xlim(left=1) # adjust the left leaving right unchanged
13081309
13091310
Setting limits turns autoscaling off for the x-axis.
13101311
13111312
Returns
13121313
-------
1313-
xmin, xmax
1314+
left, right
13141315
A tuple of the new x-axis limits.
13151316
13161317
Notes
@@ -1333,21 +1334,21 @@ def ylim(*args, **kwargs):
13331334
13341335
Call signatures::
13351336
1336-
ymin, ymax = ylim() # return the current ylim
1337-
ylim((ymin, ymax)) # set the ylim to ymin, ymax
1338-
ylim(ymin, ymax) # set the ylim to ymin, ymax
1337+
bottom, top = ylim() # return the current ylim
1338+
ylim((bottom, top)) # set the ylim to bottom, top
1339+
ylim(bottom, top) # set the ylim to bottom, top
13391340
1340-
If you do not specify args, you can alternatively pass *ymin* or *ymax* as
1341-
kwargs, i.e.::
1341+
If you do not specify args, you can alternatively pass *bottom* or
1342+
*top* as kwargs, i.e.::
13421343
1343-
ylim(ymax=3) # adjust the max leaving min unchanged
1344-
ylim(ymin=1) # adjust the min leaving max unchanged
1344+
ylim(top=3) # adjust the top leaving bottom unchanged
1345+
ylim(bottom=1) # adjust the top leaving bottom unchanged
13451346
13461347
Setting limits turns autoscaling off for the y-axis.
13471348
13481349
Returns
13491350
-------
1350-
ymin, ymax
1351+
bottom, top
13511352
A tuple of the new y-axis limits.
13521353
13531354
Notes

0 commit comments

Comments
 (0)