Revision: 6192
http://matplotlib.svn.sourceforge.net/matplotlib/?rev=6192&view=rev
Author: efiring
Date: 2008-10-14 23:25:29 +0000 (Tue, 14 Oct 2008)
Log Message:
-----------
Improve docstrings in nxutils
Modified Paths:
--------------
trunk/matplotlib/src/nxutils.c
Modified: trunk/matplotlib/src/nxutils.c
===================================================================
--- trunk/matplotlib/src/nxutils.c 2008-10-14 22:45:31 UTC (rev 6191)
+++ trunk/matplotlib/src/nxutils.c 2008-10-14 23:25:29 UTC (rev 6192)
@@ -219,9 +219,19 @@
static PyMethodDef module_methods[] = {
{"pnpoly", pnpoly, METH_VARARGS,
- "inside = pnpoly(x, y, xyverts)\nreturn 1 if x,y is inside the polygon
defined by the sequence of x,y vertices in xyverts"},
+ "inside = pnpoly(x, y, xyverts)\n\n"
+ "Return 1 if x,y is inside the polygon, 0 otherwise.\n\n"
+ "xyverts is a sequence of x,y vertices.\n\n"
+ "A point on the boundary may be treated as inside or outside.\n"
+ "See
http://www.ecse.rpi.edu/Homepages/wrf/Research/Short_Notes/pnpoly.html"},
{"points_inside_poly", points_inside_poly, METH_VARARGS,
- "mask = points_inside_poly(xypoints, xyverts)\nreturn a mask of length
xypoints indicating whether each x,y point is inside the polygon defined by the
sequence of x,y vertices in xyverts"},
+ "mask = points_inside_poly(xypoints, xyverts)\n\n"
+ "Return a boolean ndarray, True for points inside the polygon.\n\n"
+ "xypoints is a sequence of N x,y pairs.\n"
+ "xyverts is a sequence of x,y vertices of the polygon.\n"
+ "mask is an ndarray of length N.\n\n"
+ "A point on the boundary may be treated as inside or outside.\n"
+ "See
http://www.ecse.rpi.edu/Homepages/wrf/Research/Short_Notes/pnpoly.html"},
{NULL} /* Sentinel */
};
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Matplotlib-checkins mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/matplotlib-checkins
