SF.net SVN: matplotlib:[5899] trunk/matplotlib/lib/matplotlib/collections. py

[<ef...@us...>]

Revision: 5899
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=5899&view=rev
Author:   efiring
Date:     2008-07-27 02:11:05 +0000 (Sun, 27 Jul 2008)

Log Message:
-----------
Fix PolyCollection sizes kwarg docstring

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

Modified: trunk/matplotlib/lib/matplotlib/collections.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/collections.py	2008-07-27 01:17:54 UTC (rev 5898)
+++ trunk/matplotlib/lib/matplotlib/collections.py	2008-07-27 02:11:05 UTC (rev 5899)
@@ -573,8 +573,14 @@
         *verts_i* is a sequence of *xy* tuples of vertices, or an
         equivalent :mod:`numpy` array of shape (*nv*, 2).
 
-        *sizes* gives the area of the circle circumscribing the
-        polygon in points^2.
+        *sizes* is *None* (default) or a sequence of floats that
+        scale the corresponding *verts_i*.  The scaling is applied
+        before the Artist master transform; if the latter is an identity
+        transform, then the overall scaling is such that if
+        *verts_i* specify a unit square, then *sizes_i* is the area
+        of that square in points^2.
+        If len(*sizes*) < *nv*, the additional values will be
+        taken cyclically from the array.
 
         *closed*, when *True*, will explicitly close the polygon.
 
@@ -601,8 +607,6 @@
         return self._paths
 
     def draw(self, renderer):
-        # sizes is the area of the circle circumscribing the polygon
-        # in points^2
         if self._sizes is not None:
             self._transforms = [
                 transforms.Affine2D().scale(
@@ -679,8 +683,6 @@
     __init__.__doc__ = cbook.dedent(__init__.__doc__) % artist.kwdocd
 
     def draw(self, renderer):
-        # sizes is the area of the circle circumscribing the polygon
-        # in points^2
         self._transforms = [
             transforms.Affine2D().rotate(-self._rotation).scale(
                 (np.sqrt(x) * self.figure.dpi / 72.0) / np.sqrt(np.pi))


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