Merge pull request #22342 from anntzer/_qhull

timhoffm · web-flow · commit dc1e9c1c1813 · 2022-01-29T16:44:30.000+01:00
Docstrings for _qhull.
diff --git a/src/qhull_wrap.cpp b/src/qhull_wrap.cpp
@@ -301,8 +301,25 @@ version(PyObject *self, PyObject *arg)
 }
 
 static PyMethodDef qhull_methods[] = {
-    {"delaunay", delaunay, METH_VARARGS, ""},
-    {"version", version, METH_NOARGS, ""},
+    {"delaunay", delaunay, METH_VARARGS,
+     "delaunay(x, y, /)\n"
+     "--\n\n"
+     "Compute a Delaunay triangulation.\n"
+     "\n"
+     "Parameters\n"
+     "----------\n"
+     "x, y : 1d arrays\n"
+     "    The coordinates of the point set, which must consist of at least \n"
+     "    three unique points.\n"
+     "\n"
+     "Returns\n"
+     "-------\n"
+     "triangles, neighbors : int arrays, shape (ntri, 3)\n"
+     "    Indices of triangle vertices and indices of triangle neighbors.\n"
+    },
+    {"version", version, METH_NOARGS,
+     "version()\n--\n\n"
+     "Return the qhull version string."},
     {NULL, NULL, 0, NULL}
 };
 
