Skip to content

Commit 0de4831

Browse files
authored
Add Details about wkt format in API description (#365)
1 parent ddcd63e commit 0de4831

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

pedpy/data/geometry.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ def __init__(
4343
Args:
4444
polygon: A sequence of (x, y) numeric coordinate pairs, or
4545
an array-like with shape (N, 2). Also, can be a sequence of
46-
:class:`shapely.Point` objects. Passing a wkt representation of
47-
a polygon is also allowed.
46+
:class:`shapely.Point` objects. Passing a `str` sequence containing a
47+
Well-Known Text (wkt) format representation of a polygon is also allowed.
4848
obstacles (Optional): list of sequences of (x, y) numeric
4949
coordinate pairs, or an array-like with shape (N, 2). Also, can
5050
be a sequence of :class:`shapely.Point` objects.
@@ -138,8 +138,8 @@ def __init__(self, coordinates: Any):
138138
Args:
139139
coordinates: A sequence of (x, y) numeric coordinate pairs, or
140140
an array-like with shape (N, 2). Also, can be a sequence of
141-
shapely.Point objects. Passing a wkt representation of a polygon
142-
is also allowed.
141+
:class:`shapely.Point` objects. Passing a `str` sequence containing a
142+
Well-Known Text (wkt) format representation of a polygon is also allowed.
143143
"""
144144
try:
145145
self._polygon = _create_polygon_from_input(coordinates)
@@ -228,8 +228,9 @@ def __init__(self, coordinates: Any):
228228
Args:
229229
coordinates: A sequence of (x, y) numeric coordinate pairs, or
230230
an array-like with shape (N, 2). Also, can be a sequence of
231-
shapely.Point objects. Passing a wkt representation of a
232-
LineString is also allowed.
231+
:class:`shapely.Point` objects. Passing a `str` sequence containing a
232+
Well-Known Text (wkt) format representation of a LineString is also allowed.
233+
233234
"""
234235
try:
235236
if isinstance(coordinates, shapely.LineString):

0 commit comments

Comments
 (0)