Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 82c37e1

Browse files
committed
DOC: moved default to top line of kwargs
1 parent 115348f commit 82c37e1

File tree

1 file changed

+11
-26
lines changed

1 file changed

+11
-26
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 11 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6351,7 +6351,7 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
63516351
supported by `numpy.histogram_bin_edges`: 'auto', 'fd', 'doane',
63526352
'scott', 'stone', 'rice', 'sturges', or 'sqrt'.
63536353
6354-
range : tuple or None, optional
6354+
range : tuple or None, optional, default: None
63556355
The lower and upper range of the bins. Lower and upper outliers
63566356
are ignored. If not provided, *range* is ``(x.min(), x.max())``.
63576357
Range has no effect if *bins* is a sequence.
@@ -6360,9 +6360,7 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
63606360
is based on the specified bin range instead of the
63616361
range of x.
63626362
6363-
Default is ``None``
6364-
6365-
density : bool, optional
6363+
density : bool, optional, default: False
63666364
If ``True``, the first element of the return tuple will
63676365
be the raw counts per bin normalized to form a probability density
63686366
so that the area under the histogram will integrate to 1, i.e.
@@ -6373,17 +6371,14 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
63736371
If *stacked* is also ``True``, the sum of the histograms is
63746372
normalized to 1.
63756373
6376-
Default is ``False``.
63776374
6378-
weights : (n, ) array-like or None, optional
6375+
weights : (n, ) array-like or None, optional, default: None
63796376
An array of weights, of the same shape as *x*. Each value in *x*
63806377
only contributes its associated weight towards the bin count
63816378
(instead of 1). If *normed* or *density* is ``True``,
63826379
the weights are normalized, so that the integral of the density
63836380
over the range remains 1.
63846381
6385-
Default is ``None``.
6386-
63876382
This parameter can be used to draw a histogram of data that has
63886383
already been binned, e.g. using `numpy.histogram` (by treating each
63896384
bin as a single point with a weight equal to its count) ::
@@ -6393,7 +6388,7 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
63936388
63946389
(or you may alternatively use `~.bar()`).
63956390
6396-
cumulative : bool or -1, optional
6391+
cumulative : bool or -1, optional, default: False
63976392
If ``True``, then a histogram is computed where each bin gives the
63986393
counts in that bin plus all bins for smaller values. The last bin
63996394
gives the total number of datapoints.
@@ -6406,15 +6401,13 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
64066401
``True``, then the histogram is normalized such that the first bin
64076402
equals 1.
64086403
6409-
Default is ``False``
64106404
6411-
bottom : array-like, scalar, or None
6405+
bottom : array-like, scalar, or None, default: None
64126406
Location of the bottom baseline of each bin. If a scalar,
64136407
the base line for each bin is shifted by the same amount.
64146408
If an array, each bin is shifted independently and the length
64156409
of bottom must match the number of bins. If None, defaults to 0.
64166410
6417-
Default is ``None``
64186411
64196412
histtype : {'bar', 'barstacked', 'step', 'stepfilled'}, optional
64206413
The type of histogram to draw.
@@ -6428,55 +6421,47 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
64286421
64296422
Default is 'bar'
64306423
6431-
align : {'left', 'mid', 'right'}, optional
6424+
align : {'left', 'mid', 'right'}, optional, default 'mid'
64326425
The horizontal alignment of the histogram bars.
64336426
64346427
- 'left': bars are centered on the left bin edges.
64356428
- 'mid': bars are centered between the bin edges.
64366429
- 'right': bars are centered on the right bin edges.
64376430
6438-
Default is 'mid'
64396431
64406432
orientation : {'horizontal', 'vertical'}, optional
64416433
If 'horizontal', `~matplotlib.pyplot.barh` will be used for
64426434
bar-type histograms and the *bottom* kwarg will be the left edges.
64436435
6444-
rwidth : scalar or None, optional
6436+
rwidth : scalar or None, optional, default: None
64456437
The relative width of the bars as a fraction of the bin width. If
64466438
``None``, automatically compute the width.
64476439
64486440
Ignored if *histtype* is 'step' or 'stepfilled'.
64496441
6450-
Default is ``None``
64516442
6452-
log : bool, optional
6443+
log : bool, optional, default: False
64536444
If ``True``, the histogram axis will be set to a log scale. If
64546445
*log* is ``True`` and *x* is a 1D array, empty bins will be
64556446
filtered out and only the non-empty ``(n, bins, patches)``
64566447
will be returned.
64576448
6458-
Default is ``False``
6459-
6460-
color : color or array-like of colors or None, optional
6449+
color : color or array-like of colors or None, optional, default: None
64616450
Color or sequence of colors, one per dataset. Default (``None``)
64626451
uses the standard line color sequence.
64636452
64646453
Default is ``None``
64656454
6466-
label : str or None, optional
6455+
label : str or None, optional, default: None
64676456
String, or sequence of strings to match multiple datasets. Bar
64686457
charts yield multiple patches per dataset, but only the first gets
64696458
the label, so that the legend command will work as expected.
64706459
6471-
default is ``None``
6472-
6473-
stacked : bool, optional
6460+
stacked : bool, optional, default:False
64746461
If ``True``, multiple data are stacked on top of each other If
64756462
``False`` multiple data are arranged side by side if histtype is
64766463
'bar' or on top of each other if histtype is 'step'
64776464
6478-
Default is ``False``
6479-
64806465
Returns
64816466
-------
64826467
n : array or list of arrays

0 commit comments

Comments
 (0)