Browse code

fix docstring format

Jorn Hoofwijk authored on 05/07/2018 20:26:00 • Bas Nijholt committed on 11/07/2018 05:27:21
Showing 1 changed files
... ...
@@ -49,8 +49,16 @@ def fast_2d_point_in_simplex(point, simplex, eps=1e-8):
49 49
 def fast_2d_circumcircle(points):
50 50
     """
51 51
     Compute the centre and radius of the circumscribed circle of a simplex
52
-    :param points: the triangle to investigate
53
-    :return: tuple (centre point, radius)
52
+
53
+    Parameters
54
+    ----------
55
+        points: 2D array-like
56
+            the points of the triangle to investigate
57
+
58
+    Returns
59
+    -------
60
+        tuple
61
+            (centre point : tuple(int), radius: int)
54 62
     """
55 63
     points = np.array(points)
56 64
     # transform to relative coordinates