Skip to content

Fix Boxplot docs to conform to numpydoc #6240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Fix Boxplot docs to conform to numpydoc #6240

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9e0f7fe
Additional Options is not valid numpydoc but Other Parameters is
jenshnielsen Mar 29, 2016
c192bcc
Convert Other Parameters to numpy doc style
jenshnielsen Mar 29, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 22 additions & 18 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3159,24 +3159,28 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
``shownotches`` is also True. Otherwise, means will be shown
as points.

Additional Options
---------------------
The following boolean options toggle the drawing of individual
components of the boxplots:
- showcaps: the caps on the ends of whiskers
(default is True)
- showbox: the central box (default is True)
- showfliers: the outliers beyond the caps (default is True)
- showmeans: the arithmetic means (default is False)

The remaining options can accept dictionaries that specify the
style of the individual artists:
- capprops
- boxprops
- whiskerprops
- flierprops
- medianprops
- meanprops
Other Parameters
----------------
showcaps : bool, optional (True)
Show the caps on the ends of whiskers.
showbox : bool, optional (True)
Show the central box.
showfliers : bool, optional (True)
Show the outliers beyond the caps.
showmeans : bool, optional (False)
Show the arithmetic means.
capprops : dict, optional (None)
Specifies the style of the caps.
boxprops : dict, optional (None)
Specifies the style of the box.
whiskerprops : dict, optional (None)
Specifies the style of the whiskers.
flierprops : dict, optional (None)
Specifies the style of the fliers.
medianprops : dict, optional (None)
Specifies the style of the median.
meanprops : dict, optional (None)
Specifies the style of the mean.

Returns
-------
Expand Down