-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Doc tweak transform tutorial #22702
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.
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
Doc tweak transform tutorial #22702
Conversation
- Extended the headers - moved "display" to the bottom - add notes about "display" coordinates being backend dependent
Try to make it more clear that the transforms are naive-to-coordinates functions and the naming conventions / always go to display convention is to aid understanding but not inherent to the code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This all looks helpful to me, plus or minus a couple of typos/suggestions.
|"data" |The coordinate system for the data,|``ax.transData`` | | ||
| |controlled by xlim and ylim. | | | ||
+----------------+-----------------------------------+-----------------------------+ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|"data" |The coordinate system for the data,|``ax.transData`` | | |
| |controlled by xlim and ylim. | | | |
+----------------+-----------------------------------+-----------------------------+ | |
|"data" |The axes coordinate system for the data,|``ax.transData`` | | |
| |controlled by xlim and ylim. | | | |
+----------------+-----------------------------------+-----------------------------+ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would say 'The coordinate system for the data in an Axes'
The transformations also know how to invert themselves, to go from *display* | ||
back to the native coordinate system. This is particularly useful when |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The transformations also know how to invert themselves, to go from *display* | |
back to the native coordinate system. This is particularly useful when | |
The transformations also know how to invert themselves, to go from *display* | |
back to the transform's coordinate system. This is particularly useful when |
not sure this is right, but "native" isn't fully clear here...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
back to the input coordinate system?
|"data" |The coordinate system for the data,|``ax.transData`` | | ||
| |controlled by xlim and ylim. | | | ||
+----------------+-----------------------------------+-----------------------------+ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would say 'The coordinate system for the data in an Axes'
available to you, or create your own (see :mod:`matplotlib.transforms`). The | ||
table below summarizes the some useful coordinate systems, the description of | ||
that system, and the transformation object for going from that coordinate | ||
system to the *display* coordinates. In the ``Transformation Object`` column, | ||
``ax`` is a :class:`~matplotlib.axes.Axes` instance, and ``fig`` is a | ||
:class:`~matplotlib.figure.Figure` instance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We missed defining subfigure
before.
The transformations also know how to invert themselves, to go from *display* | ||
back to the native coordinate system. This is particularly useful when |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
back to the input coordinate system?
Moved to draft for now |
Co-authored-by: Elliott Sales de Andrade <[email protected]> Co-authored-by: Jody Klymak <[email protected]>
Directly took about half of the coments and tried to address the rest. |
Lets merge as an improvement. If there are further suggestions, they can come in a new PR |
PR Summary
I tried to clarify some of the transform tutorial prose based on #22688 (comment)
PR Checklist
Documentation