Fix Boxplot docs to conform to numpydoc (rebase #6240) #7275
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phobson
approved these changes
Oct 15, 2016
| showfliers : bool, optional (True) | ||
| Show the outliers beyond the caps. | ||
| showmeans : bool, optional (False) | ||
| Show the arithmetic means. |
There was a problem hiding this comment.
To be consistent with the *prop kwargs, I think it might be worth changing these to "Show_s_ the ...".
Minor nitpick. Not a show stopper.
There was a problem hiding this comment.
They're actually subtly different; on show*, the "Show the ..." is an imperative command to the boxplot function, whereas on *prop, the "Specifies ..." is a description of the parameter itself.
Of course, I'm just speculating because @jenshnielsen wrote it originally.
There was a problem hiding this comment.
Makes sense. I was just thinking:
The
medianpropsparameter specifies the style of the median
So therefore
The
showmedianparameter shows the median...
NelleV
approved these changes
Oct 16, 2016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a rebase of #6240, which seems to have been left behind at some point. The original first commit was already made by @tacaswell at some other time, so there's only one here now.
cc @jenshnielsen