SF.net SVN: matplotlib:[6902] trunk/matplotlib/lib/matplotlib/axes.py

[<as...@us...>]

Revision: 6902
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=6902&view=rev
Author:   astraw
Date:     2009-02-10 04:47:57 +0000 (Tue, 10 Feb 2009)

Log Message:
-----------
axes.py: add comment describing separation of XY plots and polar plots

Modified Paths:
--------------
    trunk/matplotlib/lib/matplotlib/axes.py

Modified: trunk/matplotlib/lib/matplotlib/axes.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/axes.py	2009-02-10 04:47:43 UTC (rev 6901)
+++ trunk/matplotlib/lib/matplotlib/axes.py	2009-02-10 04:47:57 UTC (rev 6902)
@@ -594,11 +594,20 @@
         :class:`~matplotlib.transforms.Bbox` attributes and the
         *transScale*, *transData*, *transLimits* and *transAxes*
         transformations.
+
+        .. note::
+            This method is primarily used by rectilinear projections
+            of the :class:`~matplotlib.axes.Axes` class, and is meant
+            to be overridden by new kinds of projection axes that need
+            different transformations and limits. (See
+            :class:`~matplotlib.projections.polar.PolarAxes` for an
+            example.
         """
         self.transAxes = mtransforms.BboxTransformTo(self.bbox)
 
-        # Transforms the x and y axis separately by a scale factor
+        # Transforms the x and y axis separately by a scale factor.
         # It is assumed that this part will have non-linear components
+        # (e.g. for a log scale).
         self.transScale = mtransforms.TransformWrapper(
             mtransforms.IdentityTransform())
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.