From 20afa7edae4dc0726424140625529e94e881e658 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= <hannesschoenberger@gmail.com>
Date: Tue, 21 Aug 2012 15:49:18 +0200
Subject: [PATCH] Add doc string to point in polygon functions

---
 skimage/_shared/geometry.pyx | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/skimage/_shared/geometry.pyx b/skimage/_shared/geometry.pyx
index de1ed4f4..e739f988 100644
--- a/skimage/_shared/geometry.pyx
+++ b/skimage/_shared/geometry.pyx
@@ -6,6 +6,17 @@
 
 cdef inline unsigned char point_in_polygon(int nr_verts, double *xp, double *yp,
                                            double x, double y):
+    """Test whether point lies inside a polygon.
+
+    Parameters
+    ----------
+    nr_verts : int
+        Number of vertices of polygon.
+    xp, yp : double array
+        Coordinates of polygon with length nr_verts.
+    x, y : double
+        Coordinates of point.
+    """
     cdef int i
     cdef unsigned char c = 0
     cdef int j = nr_verts - 1
@@ -22,6 +33,21 @@ cdef inline unsigned char point_in_polygon(int nr_verts, double *xp, double *yp,
 cdef void points_in_polygon(int nr_verts, double *xp, double *yp,
                             int nr_points, double *x, double *y,
                             unsigned char *result):
+    """Test whether points lie inside a polygon.
+
+    Parameters
+    ----------
+    nr_verts : int
+        Number of vertices of polygon.
+    xp, yp : double array
+        Coordinates of polygon with length nr_verts.
+    nr_points : int
+        Number of points to test.
+    x, y : double array
+        Coordinates of points.
+    result : unsigned char array
+        Test results for each point.
+    """
     cdef int n
     for n in range(nr_points):
         result[n] = point_in_polygon(nr_verts, xp, yp, x[n], y[n])