Add note about hist2d resetting axis limits #11071
Merged
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
timhoffm
approved these changes
Apr 17, 2018
lib/matplotlib/axes/_axes.py
Outdated
| @@ -6510,31 +6510,33 @@ def hist2d(self, x, y, bins=10, range=None, normed=False, weights=None, | |||
| Other Parameters | |||
| ---------------- | |||
| cmap : Colormap or str, optional | |||
| A :class:`matplotlib.colors.Colormap` instance. If not set, use rc | |||
| A :class:`.colors.Colormap` instance. If not set, use rc | |||
There was a problem hiding this comment.
Since we are using 'obj' as the default role, :class: should now be left out for improved readability.
lib/matplotlib/axes/_axes.py
Outdated
| settings. | ||
|
|
||
| norm : Normalize, optional | ||
| A :class:`matplotlib.colors.Normalize` instance is used to | ||
| A :class:`.colors.Normalize` instance is used to |
lib/matplotlib/axes/_axes.py
Outdated
| scale luminance data to ``[0, 1]``. If not set, defaults to | ||
| ``Normalize()``. | ||
| :class:`.colors.Normalize()`. |
lib/matplotlib/axes/_axes.py
Outdated
|
|
||
| vmin/vmax : None or scalar, optional | ||
| Arguments passed to the `Normalize` instance. | ||
| Arguments passed to the :class:`~.colors.Normalize` instance. |
lib/matplotlib/axes/_axes.py
Outdated
| - Currently ``hist2d`` calculates it's own axis limits, and any limits | ||
| previously set are ignored. | ||
| - Rendering the histogram with a logarithmic color scale is | ||
| accomplished by passing a :class:`.colors.LogNorm` instance to |
lib/matplotlib/axes/_axes.py
Outdated
| accomplished by passing a :class:`.colors.LogNorm` instance to | ||
| the *norm* keyword argument. Likewise, power-law normalization | ||
| (similar in effect to gamma correction) can be accomplished with | ||
| :class:`.colors.PowerNorm`. |
|
There seem to be a conflict, please backport manually |
|
@meeseeksdev backport to v2.2.2-doc |
|
There seem to be a conflict, please backport manually |
|
.py files should not be backported to that branch. |
|
Huh, but lots of .py stuff has been backported (e.g. #11046)? |
|
@meeseeksdev backport to v2.2.x @dstansby That was a mistake, I will back that out. |
|
There seem to be a conflict, please backport manually |
tacaswell
pushed a commit
to tacaswell/matplotlib
that referenced
this pull request
Aug 4, 2018
Add note about hist2d resetting axis limits
Conflicts:
lib/matplotlib/axes/_axes.py
- kept master branch version of docstrings
|
backported to v2.2.x as 636a06d |
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.
Maybe fixes #3815? I've also added a couple of other bits of markup to make the docstring nicer in general.