Skip to content

Commit

Permalink
Add note re:simple geometry and shapely Polygon
Browse files Browse the repository at this point in the history
  • Loading branch information
robbievanleeuwen committed Sep 30, 2023
1 parent 8b1db87 commit 4fe8c69
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion src/sectionproperties/pre/geometry.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,10 @@ def from_points(
Args:
points: List of points (``x``, ``y``) defining the vertices of the section
geometry.
geometry. If the geometry simply contains a continuous list of exterior
points, consider creating a :class:`shapely.Polygon` object (only
requiring points), and create a ``Geometry`` object using the
constructor.
facets: A list of (``start``, ``end``) indices of vertices defining the
edges of the section geoemtry. Can be used to define both external and
internal perimeters of holes. Facets are assumed to be described in the
Expand Down

0 comments on commit 4fe8c69

Please sign in to comment.