Skip to content

Commit d2fd168

Browse files
committed
src - Update docstring for geojson export
1 parent 4b56b97 commit d2fd168

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

overpy/format/geojson.py

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,21 @@
55

66
def dump(result, fp, nodes=False, ways=False, json_args={}):
77
"""
8+
Use the result from the Overpass API to generate GeoJSON.
9+
10+
More information:
811
9-
:param result:
12+
* http://geojson.org/
13+
14+
:param result: The result from the Overpass API
1015
:type result: overpy.Result
11-
:param fp:
16+
:param fp: Filepointer to use
17+
:param nodes: Export nodes
18+
:type nodes: bool
19+
:param ways: Export ways
20+
:type ways: bool
21+
:param json_args: Additional arguments passed to json.dump(...)
22+
:type json_args: dict
1223
:return:
1324
"""
1425
features = []
@@ -50,4 +61,4 @@ def dump(result, fp, nodes=False, ways=False, json_args={}):
5061
"features": features
5162
}
5263

53-
json.dump(geojson, fp, **json_args)
64+
json.dump(geojson, fp, **json_args)

0 commit comments

Comments
 (0)