Skip to content

Commit 7c76135

Browse files
committed
Fix: update docstring with example text @tupui
1 parent 9ca7230 commit 7c76135

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

documentation/package-documentation-best-practices.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,8 @@ def extent_to_json(ext_obj):
180180
to crop a raster image.
181181
Parameters
182182
----------
183-
ext_obj: list or geopandas geodataframe
184-
If provided with a geopandas geodataframe, the extent
183+
ext_obj: list or geopandas.GeoDataFrame
184+
If provided with a `geopandas.GeoDataFrame`, the extent
185185
will be generated from that. Otherwise, extent values
186186
should be in the order: minx, miny, maxx, maxy.
187187
Return
@@ -193,15 +193,15 @@ def extent_to_json(ext_obj):
193193
194194
Example
195195
-------
196-
Convert a geopandas GeoDataFrame to an extent dictionary:
196+
Convert a `geopandas.GeoDataFrame` to an extent dictionary:
197197
198198
>>> import geopandas as gpd
199199
>>> import earthpy.spatial as es
200200
>>> from earthpy.io import path_to_example
201201
>>> rmnp = gpd.read_file(path_to_example('rmnp.shp'))
202202
>>> es.extent_to_json(rmnp)
203203
{'type': 'Polygon', 'coordinates': (((-105.4935937, 40.1580827), ...),)}
204-
204+
205205
"""
206206

207207
```

0 commit comments

Comments
 (0)