8000 Replace "True | False" by "bool" in the docs. · matplotlib/matplotlib@5d6c42a · GitHub
[go: up one dir, main page]
Skip to content

Commit 5d6c42a

Browse files
anntzeranntzer
committed
Replace "True | False" by "bool" in the docs.
1 parent 372d5d8 commit 5d6c42a

File tree

14 files changed

+133
-108
lines changed

14 files changed

+133
-108
lines changed

‎lib/matplotlib/axes/_base.py

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -445,17 +445,16 @@ def __init__(self, fig, rect,
445445
*anchor* [ 'C', 'SW', 'S', 'SE', 'E', 'NE', 'N',
446446
'NW', 'W' ]
447447
*aspect* [ 'auto' | 'equal' | aspect_ratio ]
448-
*autoscale_on* [ *True* | *False* ] whether or not to
449-
autoscale the *viewlim*
450-
*axisbelow* [ *True* | *False* | 'line'] draw the grids
448+
*autoscale_on* bool; whether to autoscale the *viewlim*
449+
*axisbelow* [ bool | 'line' ] draw the grids
451450
and ticks below or above most other artists,
452451
or below lines but above patches
453452
*cursor_props* a (*float*, *color*) tuple
454453
*figure* a :class:`~matplotlib.figure.Figure`
455454
instance
456-
*frame_on* a boolean - draw the axes frame
455+
*frame_on* bool; whether to draw the axes frame
457456
*label* the axes label
458-
*navigate* [ *True* | *False* ]
457+
*navigate* bool
459458
*navigate_mode* [ 'PAN' | 'ZOOM' | None ] the navigation
460459
toolbar button status
461460
*position* [left, bottom, width, height] in
@@ -465,8 +464,7 @@ def __init__(self, fig, rect,
465464
*sharey* an class:`~matplotlib.axes.Axes` instance
466465
to share the y-axis with
467466
*title* the title string
468-
*visible* [ *True* | *False* ] whether the axes is
469-
visible
467+
*visible* bool, whether the axes is visible
470468
*xlabel* the xlabel
471469
*xlim* (*xmin*, *xmax*) view limits
472470
*xscale* [%(scale)s]
@@ -1289,7 +1287,7 @@ def set_aspect(self, aspect, adjustable=None, anchor=None):
12891287
anchor : None or str or 2-tuple of float, optional
12901288
If not ``None``, this defines where the Axes will be drawn if there
12911289
is extra space due to aspect constraints. The most common way to
1292-
to specify the anchor are abbreviations of carindal directions:
1290+
to specify the anchor are abbreviations of cardinal directions:
12931291
12941292
===== =====================
12951293
value description
@@ -2322,14 +2320,14 @@ def autoscale(self, enable=True, axis='both', tight=None):
23222320
23232321
Parameters
23242322
----------
2325-
enable : [True | False | None], optional
2323+
enable : bool or None, optional
23262324
True (default) turns autoscaling on, False turns it off.
23272325
None leaves the autoscaling state unchanged.
23282326
23292327
axis : ['both' | 'x' | 'y'], optional
23302328
which axis to operate on; default is 'both'
23312329
2332-
tight: [None | True | False], optional
2330+
tight: bool or None, optional
23332331
If True, set view limits to data limits;
23342332
if False, let the locator and margins expand the view limits;
23352333
if None, use tight scaling if the only artist is an image,
@@ -2667,7 +2665,7 @@ def ticklabel_format(self, **kwargs):
26672665
be used for numbers outside the range
26682666
10`m`:sup: to 10`n`:sup:.
26692667
Use (0,0) to include all numbers.
2670-
*useOffset* [True | False | offset]; if True,
2668+
*useOffset* [ bool | offset ]; if True,
26712669
the offset will be calculated as needed;
26722670
if False, no offset will be used; if a
26732671
numeric offset is specified, it will be
@@ -2752,7 +2750,7 @@ def locator_params(self, axis='both', tight=None, **kwargs):
27522750
axis : ['both' | 'x' | 'y'], optional
27532751
The axis on which to operate.
27542752
2755-
tight : [None | True | False], optional
2753+
tight : bool or None, optional
27562754
Parameter passed to :meth:`autoscale_view`.
27572755
Default is None, for no change.
27582756

‎lib/matplotlib/colorbar.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@
8888
be given, indicating the lengths of the minimum and
8989
maximum colorbar extensions respectively as a
9090
fraction of the interior colorbar length.
91-
*extendrect* [ *False* | *True* ]
91+
*extendrect* bool
9292
If *False* the minimum and maximum colorbar extensions
9393
will be triangular (the default). If *True* the
9494
extensions will be rectangular.
@@ -106,8 +106,8 @@
106106
used. An alternative
107107
:class:`~matplotlib.ticker.Formatter` object may be
108108
given instead.
109-
*drawedges* [ False | True ] If true, draw lines at color
110-
boundaries.
109+
*drawedges* bool
110+
Whether to draw lines at color boundaries.
111111
============ ====================================================
112112
113113
The following will probably be useful only in the context of

‎lib/matplotlib/contour.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1719,7 +1719,7 @@ def _initialize_x_y(self, z):
17191719
Override axis units by specifying an instance of a
17201720
:class:`matplotlib.units.ConversionInterface`.
17211721
1722-
*antialiased*: [ *True* | *False* ]
1722+
*antialiased*: bool
17231723
enable antialiasing, overriding the defaults. For
17241724
filled contours, the default is *True*. For line contours,
17251725
it is taken from rcParams['lines.antialiased'].

‎lib/matplotlib/figure.py

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -256,23 +256,20 @@ def _update_this(self, s, val):
256256
class Figure(Artist):
257257

258258
"""
259-
The Figure instance supports callbacks through a *callbacks*
260-
attribute which is a :class:`matplotlib.cbook.CallbackRegistry`
261-
instance. The events you can connect to are 'dpi_changed', and
262-
the callback will be called with ``func(fig)`` where fig is the
263-
:class:`Figure` instance.
259+
The Figure instance supports callbacks through a *callbacks* attribute
260+
which is a `~.CallbackRegistry` instance. The events you can connect to
261+
are 'dpi_changed', and the callback will be called with ``func(fig)`` where
262+
fig is the `Figure` instance.
264263
265264
Attributes
266265
----------
267266
patch
268-
The figure patch is drawn by a
269-
:class:`matplotlib.patches.Rectangle` instance
267+
The `~.Rectangle` instance representing the figure patch.
270268
271269
suppressComposite
272270
For multiple figure images, the figure will make composite images
273-
depending on the renderer option_image_nocomposite function.
274-
If *suppressComposite* is ``True`` or ``False``, this will override
275-
the renderer.
271+
depending on the renderer option_image_nocomposite function. If
272+
*suppressComposite* is a boolean, this will override the renderer.
276273
"""
277274

278275
def __str__(self):
@@ -321,10 +318,10 @@ def __init__(self,
321318
322319
tight_layout : bool
323320
If ``False`` use *subplotpars*; if ``True`` adjust subplot
324-
parameters using :meth:`tight_layout` with default padding.
321+
parameters using `~.tight_layout` with default padding.
325322
When providing a dict containing the keys
326323
``pad``, ``w_pad``, ``h_pad``, and ``rect``, the default
327-
:meth:`tight_layout` paddings will be overridden.
324+
`~.tight_layout` paddings will be overridden.
328325
Defaults to rc ``figure.autolayout``.
329326
"""
330327
Artist.__init__(self)
@@ -466,20 +463,26 @@ def _set_dpi(self, dpi, forward=True):
466463

467464
def get_tight_layout(self):
468465
"""
469-
Return whether the figure uses :meth:`tight_layout` when drawing.
466+
Return whether and how `~.tight_layout` is called when drawing.
470467
"""
471468
return self._tight
472469

473470
def set_tight_layout(self, tight):
474471
"""
475-
Set whether :meth:`tight_layout` is used upon drawing.
476-
If None, the rcParams['figure.autolayout'] value will be set.
472+
Set whether and how `~.tight_layout` is called when drawing.
477473
478-
When providing a dict containing the keys `pad`, `w_pad`, `h_pad`
479-
and `rect`, the default :meth:`tight_layout` paddings will be
480-
overridden.
481-
482-
ACCEPTS: [True | False | dict | None ]
474+
Parameters
475+
----------
476+
tight : bool or dict with keys "pad", "w_pad", "h_pad", "rect" or None
477+
If a bool, sets whether to call `~.tight_layout` upon drawing.
478+
If ``None``, use the ``figure.autolayout`` rcparam instead.
479+
If a dict, pass it as kwargs to `~.tight_layout`, overriding the
480+
default paddings.
481+
482+
..
483+
ACCEPTS: [ bool
484+
| dict with keys "pad", "w_pad", "h_pad", "rect"
485+
| None ]
483486
"""
484487
if tight is None:
485488
tight = rcParams['figure.autolayout']

‎lib/matplotlib/legend.py

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1118,49 +1118,48 @@ def set_title(self, title, prop=None):
11181118
self.stale = True
11191119

11201120
def get_title(self):
1121-
'Return `~.text.Text` instance for the legend title.'
1121+
'Return the `~.Text` instance for the legend title.'
11221122
return self._legend_title_box._text
11231123

11241124
def get_window_extent(self, *args, **kwargs):
11251125
'Return extent of the legend.'
11261126
return self.legendPatch.get_window_extent(*args, **kwargs)
11271127

11281128
def get_frame_on(self):
1129-
"""
1130-
Get whether the legend box patch is drawn.
1131-
"""
1129+
"""Get whether the legend box patch is drawn."""
11321130
return self._drawFrame
11331131

11341132
def set_frame_on(self, b):
11351133
"""
1136-
Set whether the legend box patch is drawn
1134+
Set whether the legend box patch is drawn.
11371135
1138-
ACCEPTS: [ *True* | *False* ]
1136+
Parameters
1137+
----------
1138+
b : bool
1139+
..
1140+
ACCEPTS: bool
11391141
"""
11401142
self._drawFrame = b
11411143
self.stale = True
11421144

11431145
def get_bbox_to_anchor(self):
1144-
"""
1145-
Return the bbox that the legend will be anchored.
1146-
"""
1146+
"""Return the bbox that the legend will be anchored to."""
11471147
if self._bbox_to_anchor is None:
11481148
return self.parent.bbox
11491149
else:
11501150
return self._bbox_to_anchor
11511151

11521152
def set_bbox_to_anchor(self, bbox, transform=None):
11531153
"""
1154-
Set the bbox that the legend will be anchored.
1154+
Set the bbox that the legend will be anchored to.
11551155
11561156
*bbox* can be
11571157
11581158
- A `~.BboxBase` instance
11591159
- A tuple of ``(left, bottom, width, height)`` in the given transform
11601160
(normalized axes coordinate if None)
1161-
- A tuple of ``[left, bottom]`` where the width and height will be
1161+
- A tuple of ``(left, bottom)`` where the width and height will be
11621162
assumed to be zero.
1163-
11641163
"""
11651164
if bbox is None:
11661165
self._bbox_to_anchor = None

‎lib/matplotlib/lines.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -967,9 +967,13 @@ def get_xydata(self):
967967

968968
def set_antialiased(self, b):
969969
"""
970-
True if line should be drawin with antialiased rendering
970+
Set whether to use antialiased rendering.
971971
972-
ACCEPTS: [True | False]
972+
Parameters
973+
----------
974+
b : bool
975+
..
976+
ACCEPTS: bool
973977
"""
974978
if self._antialiased != b:
975979
self.stale = True

‎lib/matplotlib/patches.py

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -246,9 +246,13 @@ def get_linestyle(self):
246246

247247
def set_antialiased(self, aa):
248248
"""
249-
Set whether to use antialiased rendering
249+
Set whether to use antialiased rendering.
250250
251-
ACCEPTS: [True | False] or None for default
251+
Parameters
252+
----------
253+
b : bool or None
254+
..
255+
ACCEPTS: bool or None
252256
"""
253257
if aa is None:
254258
aa = mpl.rcParams['patch.antialiased']
@@ -405,9 +409,13 @@ def set_ls(self, ls):
405409

406410
def set_fill(self, b):
407411
"""
408-
Set whether to fill the patch
412+
Set whether to fill the patch.
409413
410-
ACCEPTS: [True | False]
414+
Parameters
415+
----------
416+
b : bool
417+
..
418+
ACCEPTS: bool
411419
"""
412420
self._fill = bool(b)
413421
self._set_facecolor(self._original_facecolor)
@@ -1203,7 +1211,7 @@ def __init__(self, x, y, dx, dy, width=0.001, length_includes_head=False,
12031211
*width*: float (default: 0.001)
12041212
width of full arrow tail
12051213
1206-
*length_includes_head*: [True | False] (default: False)
1214+
*length_includes_head*: bool (default: False)
12071215
True if head is to be counted in calculating the length.
12081216
12091217
*head_width*: float or None (default: 3*width)
@@ -1219,7 +1227,7 @@ def __init__(self, x, y, dx, dy, width=0.001, length_includes_head=False,
12191227
fraction that the arrow is swept back (0 overhang means
12201228
triangular shape). Can be negative or greater than one.
12211229
1222-
*head_starts_at_zero*: [True | False] (default: False)
1230+
*head_starts_at_zero*: bool (default: False)
12231231
if True, the head starts being drawn at coordinate 0
12241232
instead of ending at coordinate 0.
12251233

‎lib/matplotlib/pyplot.py

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -893,21 +893,18 @@ def axes(arg=None, **kwargs):
893893
`.Figure.add_axes` respectively. Some common keyword arguments are
894894
listed below:
895895
896-
========= ============== ==============================================
897-
kwarg Accepts Description
898-
========= ============== ==============================================
899-
facecolor color the axes background color
900-
frameon [True|False] display the frame?
901-
sharex otherax current axes shares xaxis attribute
902-
with otherax
903-
sharey otherax current axes shares yaxis attribute
904-
with otherax
905-
polar [True|False] use a polar axes?
906-
aspect [str | num] ['equal', 'auto'] or a number. If a number
907-
the ratio of y-unit/x-unit in screen-space.
908-
Also see
909-
:meth:`~matplotlib.axes.Axes.set_aspect`.
910-
========= ============== ==============================================
896+
========= =========== =================================================
897+
kwarg Accepts Description
898+
========= =========== =================================================
899+
facecolor color the axes background color
900+
frameon bool whether to display the frame
901+
sharex otherax share x-axis with *otherax*
902+
sharey otherax share y-axis with *otherax*
903+
polar bool whether to use polar axes
904+
aspect [str | num] ['equal', 'auto'] or a number. If a number, the
905+
ratio of y-unit/x-unit in screen-space. See also
906+
`~.Axes.set_aspect`.
907+
========= =========== =================================================
911908
912909
Returns
913910
-------

‎lib/matplotlib/text.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -576,29 +576,30 @@ def set_clip_on(self, b):
576576
"""
577577
Set whether artist uses clipping.
578578
579-
When False artists will be visible out side of the axes which
580-
can lead to unexpected results.
579+
When False, artists will be visible outside of the axes, which can lead
580+
to unexpected results.
581581
582-
ACCEPTS: [True | False]
582+
Parameters
583+
----------
584+
b : bool
585+
..
586+
ACCEPTS: bool
583587
"""
584588
super(Text, self).set_clip_on(b)
585589
self._update_clip_properties()
586590

587591
def get_wrap(self):
588-
"""
589-
Returns the wrapping state for the text.
590-
"""
592+
"""Returns the wrapping state for the text."""
591593
return self._wrap
592594

593595
def set_wrap(self, wrap):
594596
"""Sets the wrapping state for the text.
595597
596-
..
597-
ACCEPTS: bool
598-
599598
Parameters
600599
----------
601600
wrap : bool
601+
..
602+
ACCEPTS: bool
602603
"""
603604
self._wrap = wrap
604605

‎lib/matplotlib/tri/tricontour.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ def _contour_args(self, args, kwargs):
255255
256256
tricontourf-only keyword arguments:
257257
258-
*antialiased*: [ *True* | *False* ]
258+
*antialiased*: bool
259259
enable antialiasing
260260
261261
Note: tricontourf fills intervals that are closed at the top; that

0 commit comments

Comments
 (0)
0