SF.net SVN: matplotlib:[8189] trunk/matplotlib/lib/matplotlib

[<lee...@us...>]

Revision: 8189
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=8189&view=rev
Author:   leejjoon
Date:     2010-03-12 23:23:49 +0000 (Fri, 12 Mar 2010)

Log Message:
-----------
improve legend doc. Thanks to Alan Issac

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

Modified: trunk/matplotlib/lib/matplotlib/axes.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/axes.py	2010-03-12 19:27:47 UTC (rev 8188)
+++ trunk/matplotlib/lib/matplotlib/axes.py	2010-03-12 23:23:49 UTC (rev 8189)
@@ -3964,9 +3964,11 @@
           *title* : string
             the legend title
 
-        Padding and spacing between various elements use following keywords
-        parameters. The dimensions of these values are given as a fraction
-        of the fontsize. Values from rcParams will be used if None.
+        Padding and spacing between various elements use following
+        keywords parameters. These values are measure in font-size
+        units. E.g., a fontsize of 10 points and a handlelength=5
+        implies a handlelength of 50 points.  Values from rcParams
+        will be used if None.
 
         ================   ==================================================================
         Keyword            Description

Modified: trunk/matplotlib/lib/matplotlib/legend.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/legend.py	2010-03-12 19:27:47 UTC (rev 8188)
+++ trunk/matplotlib/lib/matplotlib/legend.py	2010-03-12 23:23:49 UTC (rev 8189)
@@ -166,9 +166,11 @@
         bbox_transform     the transform for the bbox. transAxes if None.
         ================   ==================================================================
 
-The dimensions of pad and spacing are given as a fraction of the
-_fontsize. Values from rcParams will be used if None.
 
+The pad and spacing parameters are measure in font-size units.  E.g.,
+a fontsize of 10 points and a handlelength=5 implies a handlelength of
+50 points.  Values from rcParams will be used if None.
+
 Users can specify any arbitrary location for the legend using the
 *bbox_to_anchor* keyword argument. bbox_to_anchor can be an instance
 of BboxBase(or its derivatives) or a tuple of 2 or 4 floats.


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