@@ -5400,14 +5400,16 @@ def hist(self, x, bins=10, range=None, normed=False, weights=None,
5400
5400
Input values, this takes either a single array or a sequency of
5401
5401
arrays which are not required to be of the same length
5402
5402
5403
- bins : integer or array_like, optional, default: 10
5403
+ bins : integer or array_like, optional
5404
5404
If an integer is given, `bins + 1` bin edges are returned,
5405
5405
consistently with :func:`numpy.histogram` for numpy version >=
5406
5406
1.3.
5407
5407
5408
5408
Unequally spaced bins are supported if `bins` is a sequence.
5409
5409
5410
- range : tuple, optional, default: None
5410
+ default is 10
5411
+
5412
+ range : tuple or None, optional
5411
5413
The lower and upper range of the bins. Lower and upper outliers
5412
5414
are ignored. If not provided, `range` is (x.min(), x.max()). Range
5413
5415
has no effect if `bins` is a sequence.
@@ -5416,20 +5418,26 @@ def hist(self, x, bins=10, range=None, normed=False, weights=None,
5416
5418
is based on the specified bin range instead of the
5417
5419
range of x.
5418
5420
5419
- normed : boolean, optional, default: False
5421
+ Default is ``None``
5422
+
5423
+ normed : boolean, optional
5420
5424
If `True`, the first element of the return tuple will
5421
5425
be the counts normalized to form a probability density, i.e.,
5422
5426
``n/(len(x)`dbin)``, i.e., the integral of the histogram will sum
5423
5427
to 1. If *stacked* is also *True*, the sum of the histograms is
5424
5428
normalized to 1.
5425
5429
5426
- weights : array_like, shape (n, ), optional, default: None
5430
+ Default is ``False``
5431
+
5432
+ weights : (n, ) array_like or None, optional
5427
5433
An array of weights, of the same shape as `x`. Each value in `x`
5428
5434
only contributes its associated weight towards the bin count
5429
5435
(instead of 1). If `normed` is True, the weights are normalized,
5430
5436
so that the integral of the density over the range remains 1.
5431
5437
5432
- cumulative : boolean, optional, default : False
5438
+ Default is ``None``
5439
+
5440
+ cumulative : boolean, optional
5433
5441
If `True`, then a histogram is computed where each bin gives the
5434
5442
counts in that bin plus all bins for smaller values. The last bin
5435
5443
gives the total number of datapoints. If `normed` is also `True`
@@ -5439,13 +5447,17 @@ def hist(self, x, bins=10, range=None, normed=False, weights=None,
5439
5447
`True`, then the histogram is normalized such that the first bin
5440
5448
equals 1.
5441
5449
5442
- bottom : array_like, scalar, or None, default: None
5450
+ Default is ``False``
5451
+
5452
+ bottom : array_like, scalar, or None
5443
5453
Location of the bottom baseline of each bin. If a scalar,
5444
5454
the base line for each bin is shifted by the same amount.
5445
5455
If an array, each bin is shifted independently and the length
5446
5456
of bottom must match the number of bins. If None, defaults to 0.
5447
5457
5448
- histtype : ['bar' | 'barstacked' | 'step' | 'stepfilled'], optional
5458
+ Default is ``None``
5459
+
5460
+ histtype : {'bar', 'barstacked', 'step', 'stepfilled'}, optional
5449
5461
The type of histogram to draw.
5450
5462
5451
5463
- 'bar' is a traditional bar-type histogram. If multiple data
@@ -5460,7 +5472,9 @@ def hist(self, x, bins=10, range=None, normed=False, weights=None,
5460
5472
- 'stepfilled' generates a lineplot that is by default
5461
5473
filled.
5462
5474
5463
- align : ['left' | 'mid' | 'right'], optional, default: 'mid'
5475
+ Default is 'bar'
5476
+
5477
+ align : {'left', 'mid', 'right'}, optional
5464
5478
Controls how the histogram is plotted.
5465
5479
5466
5480
- 'left': bars are centered on the left bin edges.
@@ -5469,34 +5483,47 @@ def hist(self, x, bins=10, range=None, normed=False, weights=None,
5469
5483
5470
5484
- 'right': bars are centered on the right bin edges.
5471
5485
5472
- orientation : ['horizontal' | 'vertical'], optional
5486
+ Default is 'mid'
5487
+
5488
+ orientation : {'horizontal', 'vertical'}, optional
5473
5489
If 'horizontal', `~matplotlib.pyplot.barh` will be used for
5474
5490
bar-type histograms and the *bottom* kwarg will be the left edges.
5475
5491
5476
- rwidth : scalar, optional, default: None
5492
+ rwidth : scalar or None, optional
5477
5493
The relative width of the bars as a fraction of the bin width. If
5478
- `None`, automatically compute the width. Ignored if `histtype` =
5479
- 'step' or 'stepfilled'.
5494
+ `None`, automatically compute the width.
5495
+
5496
+ Ignored if `histtype` is 'step' or 'stepfilled'.
5480
5497
5481
- log : boolean, optional, default : False
5498
+ Default is ``None``
5499
+
5500
+ log : boolean, optional
5482
5501
If `True`, the histogram axis will be set to a log scale. If `log`
5483
5502
is `True` and `x` is a 1D array, empty bins will be filtered out
5484
5503
and only the non-empty (`n`, `bins`, `patches`) will be returned.
5485
5504
5486
- color : color or array_like of colors, optional, default: None
5505
+ Default is ``False``
5506
+
5507
+ color : color or array_like of colors or None, optional
5487
5508
Color spec or sequence of color specs, one per dataset. Default
5488
5509
(`None`) uses the standard line color sequence.
5489
5510
5490
- label : string, optional, default: ''
5511
+ Default is ``None``
5512
+
5513
+ label : string or None, optional
5491
5514
String, or sequence of strings to match multiple datasets. Bar
5492
5515
charts yield multiple patches per dataset, but only the first gets
5493
5516
the label, so that the legend command will work as expected.
5494
5517
5495
- stacked : boolean, optional, default : False
5518
+ default is ``None``
5519
+
5520
+ stacked : boolean, optional
5496
5521
If `True`, multiple data are stacked on top of each other If
5497
5522
`False` multiple data are aranged side by side if histtype is
5498
5523
'bar' or on top of each other if histtype is 'step'
5499
5524
5525
+ Default is ``False``
5526
+
5500
5527
Returns
5501
5528
-------
5502
5529
n : array or list of arrays
0 commit comments