Skip to content

Commit edd294e

Browse files
committed
update docstring for outline_to_surface
1 parent 9d2b236 commit edd294e

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/echosms/shape_conversions.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@ def outline_to_surface(outline: dict, num_pts:int = 20) -> dict:
2525
Notes
2626
-----
2727
Each outline cross-sectional ellipse is represented by a polygon with num_pts
28-
vertices and triangles are created that join the vertices on adjacent polygons.
29-
The two ends are meshed using Delaunay triangulation (using the `triangle` package, a
30-
wrapper around the [Triangle](https://www.cs.cmu.edu/~quake/triangle.html) mesh generator.
28+
vertices. Triangles are created that join the vertices on adjacent polygons.
29+
The two ends are meshed using an ear slicing algorithm (using the `mapbox_earcut` package, a
30+
Python binding to a [C++ implementation](https://github.com/mapbox/earcut.hpp) of the
31+
algorithm).
3132
"""
3233
num_discs = len(outline['x'])
3334

0 commit comments

Comments
 (0)