Improve docstrings in nxutils

efiring · efiring · commit 4d5f20d40898 · 2008-10-14T23:25:29.000Z
svn path=/trunk/matplotlib/; revision=6192
diff --git a/src/nxutils.c b/src/nxutils.c
@@ -219,9 +219,19 @@ points_inside_poly(PyObject *self, PyObject *args)
 
 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 */
 };
 
