Skip to content

Commit aec577d

Browse files
committed
chore: update doc strings
1 parent 2fce9d7 commit aec577d

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

src/sectionproperties/pre/geometry.py

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2704,7 +2704,14 @@ def check_geometry_overlaps(
27042704

27052705
def compound_dilation(geoms: list[Geometry], offset: float) -> CompoundGeometry:
27062706
"""
2707-
Test function for improved compound dilation
2707+
Returns a CompoundGeometry representing the input Geometries, dilated
2708+
2709+
Args:
2710+
geoms: List of Geometry
2711+
offset: a positive float or int
2712+
2713+
Returns:
2714+
The geometries dilated by 'offset'
27082715
"""
27092716
polys = [geom.geom for geom in geoms]
27102717
geom_network = build_geometry_network(polys)
@@ -2774,6 +2781,18 @@ def walk_network(
27742781

27752782

27762783
def build_geometry_network(lop: list[Polygon]) -> dict[int, set[int]]:
2784+
"""
2785+
Returns a graph describing the connectivity of each polygon to each
2786+
other polygon in 'lop'. The keys are the indexes of the polygons in
2787+
'lop' and the values are a set of indexes that the key is connected
2788+
to.
2789+
2790+
Args:
2791+
lop: List of Polygon
2792+
2793+
Returns:
2794+
A dictionary describing the connectivity graph of the polygons
2795+
"""
27772796
network: dict[int, set[int]] = {}
27782797
for idx_i, poly1 in enumerate(lop):
27792798
for idx_j, poly2 in enumerate(lop):

0 commit comments

Comments
 (0)