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

Skip to content

Commit 4b276d3

Browse files
committed
Reformat the hist() docstring.
1 parent 82fcb13 commit 4b276d3

File tree

1 file changed

+21
-28
lines changed

1 file changed

+21
-28
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6319,7 +6319,7 @@ def hist(self, x, bins=None, range=None, density=None, weights=None,
63196319
is based on the specified bin range instead of the
63206320
range of x.
63216321
6322-
Default is ``None``
6322+
Default is ``None``.
63236323
63246324
density : bool, optional
63256325
If ``True``, the first element of the return tuple will
@@ -6343,7 +6343,7 @@ def hist(self, x, bins=None, range=None, density=None, weights=None,
63436343
the weights are normalized, so that the integral of the density
63446344
over the range remains 1.
63456345
6346-
Default is ``None``
6346+
Default is ``None``.
63476347
63486348
cumulative : bool, optional
63496349
If ``True``, then a histogram is computed where each bin gives the
@@ -6355,43 +6355,36 @@ def hist(self, x, bins=None, range=None, density=None, weights=None,
63556355
In this case, if *normed* and/or *density* is also ``True``, then
63566356
the histogram is normalized such that the first bin equals 1.
63576357
6358-
Default is ``False``
6358+
Default is ``False``.
63596359
63606360
bottom : array_like, scalar, or None
63616361
Location of the bottom baseline of each bin. If a scalar,
63626362
the base line for each bin is shifted by the same amount.
63636363
If an array, each bin is shifted independently and the length
63646364
of bottom must match the number of bins. If None, defaults to 0.
63656365
6366-
Default is ``None``
6366+
Default is ``None``.
63676367
63686368
histtype : {'bar', 'barstacked', 'step', 'stepfilled'}, optional
63696369
The type of histogram to draw.
63706370
6371-
- 'bar' is a traditional bar-type histogram. If multiple data
6372-
are given the bars are arranged side by side.
6371+
- 'bar' is a traditional bar-type histogram. If multiple data are
6372+
given the bars are arranged side by side.
6373+
- 'barstacked' is a bar-type histogram where multiple data are
6374+
stacked on top of each other.
6375+
- 'step' generates a lineplot that is by default unfilled.
6376+
- 'stepfilled' generates a lineplot that is by default filled.
63736377
6374-
- 'barstacked' is a bar-type histogram where multiple
6375-
data are stacked on top of each other.
6376-
6377-
- 'step' generates a lineplot that is by default
6378-
unfilled.
6379-
6380-
- 'stepfilled' generates a lineplot that is by default
6381-
filled.
6382-
6383-
Default is 'bar'
6378+
Default is 'bar'.
63846379
63856380
align : {'left', 'mid', 'right'}, optional
63866381
Controls how the histogram is plotted.
63876382
6388-
- 'left': bars are centered on the left bin edges.
6389-
6390-
- 'mid': bars are centered between the bin edges.
6391-
6392-
- 'right': bars are centered on the right bin edges.
6383+
- 'left': bars are centered on the left bin edges.
6384+
- 'mid': bars are centered between the bin edges.
6385+
- 'right': bars are centered on the right bin edges.
63936386
6394-
Default is 'mid'
6387+
Default is 'mid'.
63956388
63966389
orientation : {'horizontal', 'vertical'}, optional
63976390
If 'horizontal', `~matplotlib.pyplot.barh` will be used for
@@ -6403,35 +6396,35 @@ def hist(self, x, bins=None, range=None, density=None, weights=None,
64036396
64046397
Ignored if *histtype* is 'step' or 'stepfilled'.
64056398
6406-
Default is ``None``
6399+
Default is ``None``.
64076400
64086401
log : bool, optional
64096402
If ``True``, the histogram axis will be set to a log scale. If
64106403
*log* is ``True`` and *x* is a 1D array, empty bins will be
64116404
filtered out and only the non-empty ``(n, bins, patches)``
64126405
will be returned.
64136406
6414-
Default is ``False``
6407+
Default is ``False``.
64156408
64166409
color : color or array_like of colors or None, optional
64176410
Color spec or sequence of color specs, one per dataset. Default
64186411
(``None``) uses the standard line color sequence.
64196412
6420-
Default is ``None``
6413+
Default is ``None``.
64216414
64226415
label : str or None, optional
64236416
String, or sequence of strings to match multiple datasets. Bar
64246417
charts yield multiple patches per dataset, but only the first gets
64256418
the label, so that the legend command will work as expected.
64266419
6427-
default is ``None``
6420+
Default is ``None``.
64286421
64296422
stacked : bool, optional
6430-
If ``True``, multiple data are stacked on top of each other If
6423+
If ``True``, multiple data are stacked on top of each other. If
64316424
``False`` multiple data are arranged side by side if histtype is
64326425
'bar' or on top of each other if histtype is 'step'
64336426
6434-
Default is ``False``
6427+
Default is ``False``.
64356428
64366429
normed : bool, optional
64376430
Deprecated; use the density keyword argument instead.

0 commit comments

Comments
 (0)