Document get_{x,y}axis_transform more prominently.

anntzer · anntzer · commit 8d8a3fc3442f · 2017-10-11T15:33:17.000-07:00
They are quite useful but right now are documented in a slightly obscure
manner.
diff --git a/tutorials/advanced/transforms_tutorial.py b/tutorials/advanced/transforms_tutorial.py
@@ -14,26 +14,33 @@
 generation, it helps to have an understanding of these objects so you
 can reuse the existing transformations matplotlib makes available to
 you, or create your own (see :mod:`matplotlib.transforms`).  The table
-below summarizes the existing coordinate systems, the transformation
+below summarizes the some useful coordinate systems, the transformation
 object you should use to work in that coordinate system, and the
 description of that system. In the `Transformation Object` column,
 ``ax`` is a :class:`~matplotlib.axes.Axes` instance, and ``fig`` is a
 :class:`~matplotlib.figure.Figure` instance.
 
-==========  =====================  ====================================================================================
-Coordinate  Transformation Object  Description
-==========  =====================  ====================================================================================
-`data`      ``ax.transData``       The userland data coordinate system, controlled by the xlim and ylim
-`axes`      ``ax.transAxes``       The coordinate system of the :class:`~matplotlib.axes.Axes`; (0, 0) is
-                                   bottom left of the axes, and (1, 1) is top right of the axes.
-`figure`    ``fig.transFigure``    The coordinate system of the :class:`~matplotlib.figure.Figure`; (0, 0)
-                                   is bottom left of the figure, and (1, 1) is top right of the figure.
-`display`   `None`                 This is the pixel coordinate system of the display; (0, 0) is the bottom
-                                   left of the display, and (width, height) is the top right of the display in pixels.
-                                   Alternatively, the identity transform
-                                   (:class:`matplotlib.transforms.IdentityTransform()`) may be used instead of None.
-==========  =====================  ====================================================================================
-
+=========== ============================= =====================================
+Coordinates Transformation object         Description
+=========== ============================= =====================================
+"data"      ``ax.transData````            The coordinate system for the data,
+                                          controlled by xlim and ylim.
+"axes"      ``ax.transAxes``              The coordinate system of the
+                                          `~.Axes`; (0, 0) is bottom left of
+                                          the axes, and (1, 1) is top right of
+                                          the axes.
+"figure"    ``fig.transFigure``           The coordinate system of the
+                                          `~.Figure`; (0, 0) is bottom left of
+                                          the figure, and (1, 1) is top right
+                                          of the figure.
+"display"   ``None``, or                  The pixel coordinate system of the
+            ``IdentityTransform()``       display; (0, 0) is bottom left of the
+                                          display, and (width, height) is top
+                                          right of the display in pixels.
+"xaxis",    ``ax.get_xaxis_transform()``, Blended coordinate systems; use data
+"yaxis"     ``ax.get_yaxis_transform()``  coordinates on one of the axis and
+                                          axes coordinates on the other.
+=========== ============================= =====================================
 
 All of the transformation objects in the table above take inputs in
 their coordinate system, and transform the input to the `display`
@@ -457,5 +464,5 @@
 # best way to learn more is to open the source for those packages and
 # see how to make your own, since matplotlib supports extensible axes
 # and projections.  Michael Droettboom has provided a nice tutorial
-# example of creating a hammer projection axes; see
+# example of creating a Hammer projection axes; see
 # :ref:`sphx_glr_gallery_api_custom_projection_example.py`.
