From f18364ec6522466afbdd64bdf563a54c9e6e4db9 Mon Sep 17 00:00:00 2001 From: Shivesh Mandalia Date: Tue, 3 Mar 2020 02:36:22 +0000 Subject: documentation --- golemflavor/plot.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'golemflavor') diff --git a/golemflavor/plot.py b/golemflavor/plot.py index acf0209..02aa232 100644 --- a/golemflavor/plot.py +++ b/golemflavor/plot.py @@ -298,14 +298,15 @@ def tax_fill(ax, points, nbins, **kwargs): def alpha_shape(points, alpha): - """ - Compute the alpha shape (concave hull) of a set - of points. - @param points: Iterable container of points. - @param alpha: alpha value to influence the - gooeyness of the border. Smaller numbers - don't fall inward as much as larger numbers. - Too large, and you lose everything! + """Compute the alpha shape (concave hull) of a set of points. + + Parameters + ---------- + points: Iterable container of points. + alpha: alpha value to influence the gooeyness of the border. Smaller + numbers don't fall inward as much as larger numbers. Too large, and you + lose everything! + """ if len(points) < 4: # When you have a triangle, there is no sense -- cgit v1.2.3