Tweak Polyline#d.centroid docs

Jciel · Apr 18, 2019 · 353d641 · 353d641
1 parent 61a37f2
commit 353d641
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/Polyline2d.elm b/src/Polyline2d.elm
@@ -314,8 +314,8 @@ boundingBox polyline =
     BoundingBox2d.containingPoints (vertices polyline)
 
 
-{-| Find the centroid of the polyline. Returns `Nothing` if the polyline
-has no vertices.
+{-| Find the centroid (center of mass) of a polyline. Returns `Nothing` if the
+polyline has no vertices.
 
     Polyline2d.centroid stepShape
     --> Just (Point2d.fromCoordinates ( 1.0, 0.5 ))

diff --git a/src/Polyline3d.elm b/src/Polyline3d.elm
@@ -364,8 +364,8 @@ boundingBox polyline =
     BoundingBox3d.containingPoints (vertices polyline)
 
 
-{-| Find the centroid of the polyline. Returns `Nothing` if the polyline
-has no vertices.
+{-| Find the centroid (center of mass) of a polyline. Returns `Nothing` if the
+polyline has no vertices.
 
     Polyline3d.centroid examplePolyline
     --> Just (Point3d.fromCoordinates ( 0.9167, 1.333, 0.75 ))