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

Skip to content

Commit c887ad7

Browse files
committed
DOC: add whitespace around params
1 parent 14192ca commit c887ad7

1 file changed

Lines changed: 37 additions & 16 deletions

File tree

lib/matplotlib/axes/_axes.py

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3078,17 +3078,21 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
30783078
----------
30793079
x : Array or a sequence of vectors.
30803080
The input data.
3081+
30813082
notch : bool, optional (False)
30823083
If `True`, will produce a notched box plot. Otherwise, a
30833084
rectangular boxplot is produced.
3085+
30843086
sym : str, optional
30853087
The default symbol for flier points. Enter an empty string
30863088
('') if you don't want to show fliers. If `None`, then the
30873089
fliers default to 'b+' If you want more control use the
30883090
flierprops kwarg.
3091+
30893092
vert : bool, optional (True)
30903093
If `True` (default), makes the boxes vertical. If `False`,
30913094
everything is drawn horizontally.
3095+
30923096
whis : float, sequence, or string (default = 1.5)
30933097
As a float, determines the reach of the whiskers past the
30943098
first and third quartiles (e.g., Q3 + whis*IQR,
@@ -3100,6 +3104,7 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
31003104
to set the whiskers at specific percentiles of the data.
31013105
Finally, ``whis`` can be the string ``'range'`` to force the
31023106
whiskers to the min and max of the data.
3107+
31033108
bootstrap : int, optional
31043109
Specifies whether to bootstrap the confidence intervals
31053110
around the median for notched boxplots. If `bootstrap` is None,
@@ -3110,12 +3115,14 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
31103115
times to bootstrap the median to determine its 95%
31113116
confidence intervals. Values between 1000 and 10000 are
31123117
recommended.
3118+
31133119
usermedians : array-like, optional
31143120
An array or sequence whose first dimension (or length) is
31153121
compatible with ``x``. This overrides the medians computed
31163122
by matplotlib for each element of ``usermedians`` that is not
31173123
`None`. When an element of ``usermedians`` is None, the median
31183124
will be computed by matplotlib as normal.
3125+
31193126
conf_intervals : array-like, optional
31203127
Array or sequence whose first dimension (or length) is
31213128
compatible with ``x`` and whose second dimension is 2. When
@@ -3124,27 +3131,34 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
31243131
(provided ``notch`` is `True`). When an element of
31253132
``conf_intervals`` is `None`, the notches are computed by the
31263133
method specified by the other kwargs (e.g., ``bootstrap``).
3134+
31273135
positions : array-like, optional
31283136
Sets the positions of the boxes. The ticks and limits are
31293137
automatically set to match the positions. Defaults to
31303138
`range(1, N+1)` where N is the number of boxes to be drawn.
3139+
31313140
widths : scalar or array-like
31323141
Sets the width of each box either with a scalar or a
31333142
sequence. The default is 0.5, or ``0.15*(distance between
31343143
extreme positions)``, if that is smaller.
3144+
31353145
patch_artist : bool, optional (False)
31363146
If `False` produces boxes with the Line2D artist. Otherwise,
31373147
boxes and drawn with Patch artists.
3148+
31383149
labels : sequence, optional
31393150
Labels for each dataset. Length must be compatible with
31403151
dimensions of ``x``.
3152+
31413153
manage_xticks : bool, optional (True)
31423154
If the function should adjust the xlim and xtick locations.
3155+
31433156
autorange : bool, optional (False)
31443157
When `True` and the data are distributed such that the 25th and
31453158
75th percentiles are equal, ``whis`` is set to ``'range'`` such
31463159
that the whisker ends are at the minimum and maximum of the
31473160
data.
3161+
31483162
meanline : bool, optional (False)
31493163
If `True` (and ``showmeans`` is `True`), will try to render
31503164
the mean as a line spanning the full width of the box
@@ -3174,20 +3188,27 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
31743188
Returns
31753189
-------
31763190
result : dict
3177-
A dictionary mapping each component of the boxplot
3178-
to a list of the :class:`matplotlib.lines.Line2D`
3179-
instances created. That dictionary has the following keys
3180-
(assuming vertical boxplots):
3181-
3182-
- boxes: the main body of the boxplot showing the quartiles
3183-
and the median's confidence intervals if enabled.
3184-
- medians: horizonal lines at the median of each box.
3185-
- whiskers: the vertical lines extending to the most extreme,
3186-
non-outlier data points.
3187-
- caps: the horizontal lines at the ends of the whiskers.
3188-
- fliers: points representing data that extend beyond the
3189-
whiskers (outliers).
3190-
- means: points or lines representing the means.
3191+
A dictionary mapping each component of the boxplot to a list
3192+
of the :class:`matplotlib.lines.Line2D` instances
3193+
created. That dictionary has the following keys (assuming
3194+
vertical boxplots):
3195+
3196+
- ``boxes``: the main body of the boxplot showing the
3197+
quartiles and the median's confidence intervals if
3198+
enabled.
3199+
3200+
- ``medians``: horizontal lines at the median of each box.
3201+
3202+
- ``whiskers``: the vertical lines extending to the most
3203+
extreme, non-outlier data points.
3204+
3205+
- ``caps``: the horizontal lines at the ends of the
3206+
whiskers.
3207+
3208+
- ``fliers``: points representing data that extend beyond
3209+
the whiskers (fliers).
3210+
3211+
- ``means``: points or lines representing the means.
31913212
31923213
Examples
31933214
--------
@@ -3448,10 +3469,10 @@ def bxp(self, bxpstats, positions=None, widths=None, vert=True,
34483469
quartiles and the median's confidence intervals if
34493470
enabled.
34503471
3451-
- ``medians``: horizonal lines at the median of each box.
3472+
- ``medians``: horizontal lines at the median of each box.
34523473
34533474
- ``whiskers``: the vertical lines extending to the most
3454-
extreme, n-outlier data points.
3475+
extreme, non-outlier data points.
34553476
34563477
- ``caps``: the horizontal lines at the ends of the
34573478
whiskers.

0 commit comments

Comments
 (0)