Merged revisions 8559 via svnmerge from

ianthomas23 · ianthomas23 · commit 2135d788a3c7 · 2010-07-16T13:55:35.000Z
https://matplotlib.svn.sourceforge.net/svnroot/matplotlib/branches/v1_0_maint ........ r8559 | ianthomas23 | 2010-07-16 14:46:14 +0100 (Fri, 16 Jul 2010) | 2 lines Added tri* functions to pyplot docs. ........ svn path=/trunk/matplotlib/; revision=8560
diff --git a/doc/_templates/index.html b/doc/_templates/index.html
@@ -994,7 +994,6 @@ <h3>plotting commands</h3> <br/>
       </td>
 
     </tr>
-
     <tr>
       <th align="left">
         <a href="api/pyplot_api.html#matplotlib.pyplot.title">title</a>
@@ -1005,6 +1004,50 @@ <h3>plotting commands</h3> <br/>
         add a title to the current axes
       </td>
 
+    </tr>
+    <tr>
+      <th align="left">
+        <a href="api/pyplot_api.html#matplotlib.pyplot.tricontour">tricontour</a>
+
+      </th>
+
+      <td align="left">
+        make a contour plot on a triangular grid
+      </td>
+
+    </tr>
+    <tr>
+      <th align="left">
+        <a href="api/pyplot_api.html#matplotlib.pyplot.tricontourf">tricontourf</a>
+
+      </th>
+
+      <td align="left">
+        make a filled contour plot on a triangular grid
+      </td>
+
+    </tr>
+    <tr>
+      <th align="left">
+        <a href="api/pyplot_api.html#matplotlib.pyplot.tripcolor">tripcolor</a>
+
+      </th>
+
+      <td align="left">
+        make a pseudocolor plot on a triangular grid
+      </td>
+
+    </tr>
+    <tr>
+      <th align="left">
+        <a href="api/pyplot_api.html#matplotlib.pyplot.triplot">triplot</a>
+
+      </th>
+
+      <td align="left">
+        plot a triangular grid
+      </td>
+
     </tr>
     <tr>
       <th align="left">
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -117,6 +117,21 @@ Changes beyond 0.99.x
 
     draw_image(self, gc, x, y, im)
 
+* There are four new Axes methods with corresponding pyplot
+  functions that deal with unstructured triangular grids:
+
+  + :meth:`matplotlib.axes.Axes.tricontour` draws contour lines
+    on a triangular grid.
+
+  + :meth:`matplotlib.axes.Axes.tricontourf` draws filled contours
+    on a triangular grid.
+
+  + :meth:`matplotlib.axes.Axes.tripcolor` draws a pseudocolor
+    plot on a triangular grid.
+
+  + :meth:`matplotlib.axes.Axes.triplot` draws a triangular grid
+    as lines and/or markers.
+
 Changes in 0.99
 ======================
 
diff --git a/lib/matplotlib/pylab.py b/lib/matplotlib/pylab.py
@@ -92,6 +92,10 @@
   tick_params - control the appearance of ticks and tick labels
   ticklabel_format - control the format of tick labels
   title    - add a title to the current axes
+  tricontour - make a contour plot on a triangular grid
+  tricontourf - make a filled contour plot on a triangular grid
+  tripcolor - make a pseudocolor plot on a triangular grid
+  triplot - plot a triangular grid
   xcorr   - plot the autocorrelation function of x and y
   xlim     - set/get the xlimits
   ylim     - set/get the ylimits
diff --git a/lib/matplotlib/tri/tricontour.py b/lib/matplotlib/tri/tricontour.py
@@ -93,7 +93,8 @@ def _contour_args(self, args, kwargs):
     tricontour_doc = """
         :func:`~matplotlib.pyplot.tricontour` and
         :func:`~matplotlib.pyplot.tricontourf` draw contour lines and
-        filled contours, respectively.  Except as noted, function
+        filled contours, respectively, on an unstructured triangular
+        grid.  Except as noted, function
         signatures and return values are the same for both versions.
 
         The triangulation can be specified in one of two ways; either::
