Skip to content

Commit 9ca7230

Browse files
committed
Fix: add text to example in docstring and spaces review- @tupui
1 parent cf4c14a commit 9ca7230

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

documentation/package-documentation-best-practices.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,14 +190,18 @@ def extent_to_json(ext_obj):
190190
for the extent
191191
A GeoJSON style dictionary of corner coordinates representing
192192
the spatial extent of the provided spatial object.
193+
193194
Example
194195
-------
196+
Convert a geopandas GeoDataFrame to an extent dictionary:
197+
195198
>>> import geopandas as gpd
196199
>>> import earthpy.spatial as es
197200
>>> from earthpy.io import path_to_example
198201
>>> rmnp = gpd.read_file(path_to_example('rmnp.shp'))
199202
>>> es.extent_to_json(rmnp)
200203
{'type': 'Polygon', 'coordinates': (((-105.4935937, 40.1580827), ...),)}
204+
201205
"""
202206

203207
```

0 commit comments

Comments
 (0)