Mention origin and extent tutorial in API docs for origin kwarg #14464
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
|
Looks good but one of your lines is too long. |
c30816c to
fc1eed9
Compare
|
Oops, fixed. |
timhoffm
reviewed
Jun 6, 2019
| @@ -5519,6 +5519,9 @@ def imshow(self, X, cmap=None, norm=None, aspect=None, | |||
| Note that the vertical axes points upward for 'lower' | |||
| but downward for 'upper'. | |||
|
|
|||
| See the example :doc:`/tutorials/intermediate/imshow_extent` for | |||
| examples and a more detailed description. | |||
There was a problem hiding this comment.
Suggested change
| ex 8000 amples and a more detailed description. | |
| a more detailed description. |
I would keep this exactly the same as in the sentence in the extentparameter description. Twice using example is kind of redundant. 😄
There was a problem hiding this comment.
I'll keep them consistent but I think the current spelling is actually a little confusing.
Also reword existing note for extent keyword to harmonize and make clearer
fc1eed9 to
2ac762a
Compare
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Jun 7, 2019
…PI docs for origin kwarg
dstansby
added a commit
that referenced
this pull request
Jun 7, 2019
…464-on-v3.1.x Backport PR #14464 on branch v3.1.x (Mention origin and extent tutorial in API docs for origin kwarg)
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.
PR Summary
This adds a link to the origin and extent tutorial. There's already a link for the extent kwarg below this but I don't think it hurts to have two links since at least for myself I tend to go tunnel vision in these API docs pages and ignore kwargs I don't think I need to care about.
PR Checklist