Skip to content

Commit

Permalink
Merge pull request #76 from frewsxcv/doc
Browse files Browse the repository at this point in the history
Clarified map_coords
  • Loading branch information
frewsxcv committed Apr 24, 2016
2 parents bfea4a8 + 529d41e commit 00c37fd
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions geojson/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,16 @@ def coords(obj):

def map_coords(func, obj):
"""
Returns the coordinates from a Geometry after applying the provided
function to the tuples.
Returns the mapped coordinates from a Geometry after applying the provided
function to each dimension in tuples list (ie, linear scaling).
:param func: Function to apply to tuples
:type func: function
:param obj: A geometry or feature to extract the coordinates from.
:type obj: Point, LineString, MultiPoint, MultiLineString, Polygon,
MultiPolygon
:return: The result of applying the function to each coordinate array.
:return: The result of applying the function to each dimension in the
array.
:rtype: list
:raises ValueError: if the provided object is not a Geometry.
"""
Expand Down

0 comments on commit 00c37fd

Please sign in to comment.