Update hist() docstring following removal of normed kwarg. #14604
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
dstansby
reviewed
Jun 24, 2019
|
very, very slowly :p |
timhoffm
reviewed
Jun 24, 2019
lib/matplotlib/axes/_axes.py
Outdated
| If *density* is also ``True`` then the histogram is normalized such | ||
| that the last bin equals 1. | ||
|
|
||
| If *cumulative* is to less than 0 (e.g., -1), the direction of |
There was a problem hiding this comment.
Suggested change
| If *cumulative* is to less than 0 (e.g., -1), the direction of | |
| If *cumulative* is a number less than 0 (e.g., -1), the direction of |
That should be mentioned in the type. Just bool is plain confusing. Maybe we could also deprecate numbers in favor of "reversed", but that's for another PR.
There was a problem hiding this comment.
I now documented the type as bool or -1 which is technically too restrictive but more informative in practice, I think.
and change the default of density from None to False. (This doesn't change anything from the API PoV as we convert the kwarg using `bool` anyways, but the default was previously `None` for the sole purpose of detecting when both `normed` and `density` were both passed and error out in that case.)
timhoffm
approved these changes
Jun 25, 2019
|
@meeseeksdev backport to v3.1.x |
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Jul 17, 2019
…al of normed kwarg.
|
This is documenting changes in #14244 which is targetting 3.2. |
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.
and change the default of density from None to False. (This doesn't
change anything from the API PoV as we convert the kwarg using
boolanyways, but the default was previously
Nonefor the sole purpose ofdetecting when both
normedanddensitywere both passed and errorout in that case.)
PR Summary
PR Checklist