8000 DOC: cleanup dosctrings · matplotlib/matplotlib@5ff37d9 · GitHub
[go: up one dir, main page]
Skip to content

Commit 5ff37d9

Browse files
jklymakjklymak
committed
DOC: cleanup dosctrings
1 parent 8139aa9 commit 5ff37d9

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed

‎lib/matplotlib/axes/_base.py

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3074,25 +3074,25 @@ def set_xlim(self, left=None, right=None, emit=True, auto=False,
30743074
The left xlim (default: None, which leaves the left limit
30753075
unchanged).
30763076
The left and right xlims may be passed as the tuple
3077-
(`left`, `right`) as the first positional argument (or as
3078-
the `left` keyword argument).
3077+
(*left*, *right*) as the first positional argument (or as
3078+
the *left* keyword argument).
30793079
30803080
right : scalar, optional
3081-
The right xlim (default: None, which leaves the right limit
3081+
The right xlim (default: ``None``, which leaves the right limit
30823082
unchanged).
30833083
30843084
emit : bool, optional
3085-
Whether to notify observers of limit change (default: True).
3085+
Whether to notify observers of limit change (default: ``True``).
30863086
3087-
auto : bool or None, optional
3088-
Whether to turn on autoscaling of the x-axis. True turns on,
3089-
False turns off (default action), None leaves unchanged.
3087+
auto : bool or ``None``, optional
3088+
Whether to turn on autoscaling of the x-axis. ``True`` turns on,
3089+
``False`` turns off (default action), ``None`` leaves unchanged.
30903090
30913091
xmin, xmax : scalar, optional
30923092
These arguments are deprecated and will be removed in a future
30933093
version. They are equivalent to left and right respectively,
3094-
and it is an error to pass both `xmin` and `left` or
3095-
`xmax` and `right`.
3094+
and it is an error to pass both *xmin* and *left* or
3095+
*xmax* and *right*.
30963096
30973097
Returns
30983098
-------
@@ -3101,7 +3101,7 @@ def set_xlim(self, left=None, right=None, emit=True, auto=False,
31013101
31023102
Notes
31033103
-----
3104-
The `left` value may be greater than the `right` value, in which
3104+
The *left* value may be greater than the *right* value, in which
31053105
case the x-axis values will decrease from left to right.
31063106
31073107
Examples
@@ -3115,7 +3115,7 @@ def set_xlim(self, left=None, right=None, emit=True, auto=False,
31153115
>>> set_xlim(right=right_lim)
31163116
31173117
Limits may be passed in reverse order to flip the direction of
3118-
the x-axis. For example, suppose `x` represents the number of
3118+
the x-axis. For example, suppose *x* represents the number of
31193119
years before present. The x-axis limits might be set like the
31203120
following so 5000 years ago is on the left of the plot and the
31213121
present is on the right.
@@ -3408,15 +3408,15 @@ def set_ylim(self, bottom=None, top=None, emit=True, auto=False,
34083408
The bottom ylim (default: None, which leaves the bottom
34093409
limit unchanged).
34103410
The bottom and top ylims may be passed as the tuple
3411-
(`bottom`, `top`) as the first positional argument (or as
3412-
the `bottom` keyword argument).
3411+
(*bottom*, *top*) as the first positional argument (or as
3412+
the *bottom* keyword argument).
34133413
34143414
top : scalar, optional
3415-
The top ylim (default: None, which leaves the top limit
3415+
The top ylim (default: ``None``, which leaves the top limit
34163416
unchanged).
34173417
34183418
emit : bool, optional
3419-
Whether to notify observers of limit change (default: True).
3419+
Whether to notify observers of limit change (default: ``True``).
34203420
34213421
auto : bool or None, optional
34223422
Whether to turn on autoscaling of the y-axis. True turns on,
@@ -3425,17 +3425,17 @@ def set_ylim(self, bottom=None, top=None, emit=True, auto=False,
34253425
ymin, ymax : scalar, optional
34263426
These arguments are deprecated and will be removed in a future
34273427
version. They are equivalent to bottom and top respectively,
3428-
and it is an error to pass both `ymin` and `bottom` or
3429-
`ymax` and `top`.
3428+
and it is an error to pass both *ymin* and *bottom* or
3429+
*ymax* and *top*.
34303430
34313431
Returns
34323432
-------
34333433
ylimits : tuple
3434-
Returns the new y-axis limits as (`bottom`, `top`).
3434+
Returns the new y-axis limits as (*bottom*, *top*).
34353435
34363436
Notes
34373437
-----
3438-
The `bottom` value may be greater than the `top` value, in which
3438+
The *bottom* value may be greater than the *top* value, in which
34393439
case the y-axis values will decrease from bottom to top.
34403440
34413441
Examples

‎lib/matplotlib/projections/polar.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1185,7 +1185,7 @@ def get_rorigin(self):
11851185

11861186
def set_rlim(self, bottom=None, top=None, emit=True, auto=False, **kwargs):
11871187
"""
1188-
See `~.polar.PolarAxes.set_ylim`
1188+
See `~.polar.PolarAxes.set_ylim`.
11891189
"""
11901190
if 'rmin' in kwargs:
11911191
if bottom is None:
@@ -1205,16 +1205,16 @@ def set_rlim(self, bottom=None, top=None, emit=True, auto=False, **kwargs):
12051205
def set_ylim(self, bottom=None, top=None, emit=True, auto=False,
12061206
*, ymin=None, ymax=None):
12071207
"""
1208-
Set the data limits for the radial-axis
1208+
Set the data limits for the radial-axis.
12091209
12101210
Parameters
12111211
----------
12121212
bottom : scalar, optional
12131213
The bottom limit (default: None, which leaves the bottom
12141214
limit unchanged).
12151215
The bottom and top ylims may be passed as the tuple
1216-
(`bottom`, `top`) as the first positional argument (or as
1217-
the `bottom` keyword argument).
1216+
(*bottom*, *top*) as the first positional argument (or as
1217+
the *bottom* keyword argument).
12181218
12191219
top : scalar, optional
12201220
The top ylim (default: None, which leaves the top limit
@@ -1230,17 +1230,17 @@ def set_ylim(self, bottom=None, top=None, emit=True, auto=False,
12301230
ymin, ymax : scalar, optional
12311231
These arguments are deprecated and will be removed in a future
12321232
version. They are equivalent to bottom and top respectively,
1233-
and it is an error to pass both `ymin` and `bottom` or
1233+
and it is an error to pass both *ymin* and *bottom* or
12341234
`ymax` and `top`.
12351235
12361236
Returns
12371237
-------
12381238
ylimits : tuple
1239-
Returns the new y-axis limits as (`bottom`, `top`).
1239+
Returns the new y-axis limits as (*bottom*, *top*).
12401240
12411241
Notes
12421242
-----
1243-
The `bottom` value must be less than the `top` value, or a
1243+
The *bottom* value must be less than the *top* value, or a
12441244
ValueError is raised.
12451245
"""
12461246

@@ -1260,7 +1260,7 @@ def set_ylim(self, bottom=None, top=None, emit=True, auto=False,
12601260
top = bottom[1]
12611261
bottom = bottom[0]
12621262
if bottom >= top:
1263-
raise ValueError('polar axes y/r-limits must be increasing; '
1263+
raise ValueError('Polar axes y/r-limits must be increasing; '
12641264
'i.e. bottom < top')
12651265

12661266
return super().set_ylim(bottom=bottom, top=top, emit=emit, auto=auto)

0 commit comments

Comments
 (0)
0