SF.net SVN: matplotlib:[6065] trunk/matplotlib/lib/matplotlib/contour.py

[<ry...@us...>]

Revision: 6065
          http://matplotlib.svn.sourceforge.net/matplotlib/?rev=6065&view=rev
Author:   ryanmay
Date:     2008-09-04 19:56:37 +0000 (Thu, 04 Sep 2008)

Log Message:
-----------
Document the linestyles keyword argument to contour.

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

Modified: trunk/matplotlib/lib/matplotlib/contour.py
===================================================================
--- trunk/matplotlib/lib/matplotlib/contour.py	2008-09-04 19:52:42 UTC (rev 6064)
+++ trunk/matplotlib/lib/matplotlib/contour.py	2008-09-04 19:56:37 UTC (rev 6065)
@@ -998,13 +998,26 @@
 
           *linewidths*: [ None | number | tuple of numbers ]
             If *linewidths* is *None*, the default width in
-            ``lines.linewidth`` in ``matplotlibrc`` is used
+            ``lines.linewidth`` in ``matplotlibrc`` is used.
 
             If a number, all levels will be plotted with this linewidth.
 
             If a tuple, different levels will be plotted with different
             linewidths in the order specified
 
+          *linestyles*: [None | 'solid' | 'dashed' | 'dashdot' | 'dotted' ]
+            If *linestyles* is *None*, the 'solid' is used.
+            
+            *linestyles* can also be an iterable of the above strings
+            specifying a set of linestyles to be used. If this
+            iterable is shorter than the number of contour levels
+            it will be repeated as necessary.
+            
+            If contour is using a monochrome colormap and the contour
+            level is less than 0, then the linestyle specified
+            in ``contour.negative_linestyle`` in ``matplotlibrc``
+            will be used.
+
         contourf-only keyword arguments:
 
           *antialiased*: [ True | False ]


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