numpydoc AxesImage #15523
Merged
numpydoc AxesImage #15523
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
commented
Oct 26, 2019
| @@ -218,6 +218,19 @@ def _rgb_to_rgba(A): | |||
|
|
|||
|
|
|||
| class _ImageBase(martist.Artist, cm.ScalarMappable): | |||
| """ | |||
There was a problem hiding this comment.
I had to move this up to avoid it appearing under the AxesImage main docstring (this doesn't affect the docs though since _ImageBase isn't in there).
a7d134d to
4d1e146
Compare
NelleV
approved these changes
Oct 28, 2019
| When True, use a full resampling method. When False, only resample when | ||
| the output image is larger than the input image. | ||
| **kwargs | ||
| Additional kwargs are matplotlib.artist properties. |
There was a problem hiding this comment.
If you use backticks around matplotlib.artist, sphinx should do it's magic and automatically link to the reference page of the artist. It's pretty cool :)
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Oct 28, 2019
timhoffm
added a commit
that referenced
this pull request
Oct 28, 2019
…523-on-v3.2.x Backport PR #15523 on branch v3.2.x (numpydoc AxesImage)
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.
I have taken a pretty awful docstring and made it slightly less awful by putting it in numpydoc format... not perfect but slightly better.