Skip to content

Mention origin and extent tutorial in API docs for origin kwarg #14464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 7, 2019
Merged

Mention origin and extent tutorial in API docs for origin kwarg #14464

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 :doc:`/tutorials/intermediate/imshow_extent` tutorial for
examples and a more detailed description.
Copy link
Member

@timhoffm timhoffm Jun 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
examples 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. 😄

https://21987-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/api/_as_gen/matplotlib.axes.Axes.imshow.html#matplotlib.axes.Axes.imshow

Copy link
Contributor Author

@ngoldbaum ngoldbaum Jun 6, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll keep them consistent but I think the current spelling is actually a little confusing.


extent : scalars (left, right, bottom, top), optional
The bounding box in data coordinates that the image will fill.
The image is stretched individually along x and y to fill the box.
Expand All @@ -5536,8 +5539,8 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
- For ``origin == 'lower'`` the default is
``(-0.5, numcols-0.5, -0.5, numrows-0.5)``.

See the example :doc:`/tutorials/intermediate/imshow_extent` for a
more detailed description.
See the :doc:`/tutorials/intermediate/imshow_extent` tutorial for
examples and a more detailed description.

filternorm : bool, optional, default: True
A parameter for the antigrain image resize filter (see the
Expand Down