diff --git a/doc/source/quick_start.md b/doc/source/quick_start.md index abaa6371..4fc5cb4d 100644 --- a/doc/source/quick_start.md +++ b/doc/source/quick_start.md @@ -85,7 +85,7 @@ For convenience and consistency, nearly all of these methods can be passed solel # Print initial bounds of the raster print(rast.bounds) # Crop raster to vector's extent -rast.crop(vect) +rast = rast.crop(vect) # Print bounds of cropped raster print(rast.bounds) ``` diff --git a/doc/source/raster_class.md b/doc/source/raster_class.md index f18fa83d..0f4c4d54 100644 --- a/doc/source/raster_class.md +++ b/doc/source/raster_class.md @@ -253,12 +253,12 @@ See {ref}`core-match-ref` for more details. ``` The {func}`~geoutils.Raster.crop` function can also be passed a {class}`list` or {class}`tuple` of bounds (`xmin`, `ymin`, `xmax`, `ymax`). By default, -{func}`~geoutils.Raster.crop` is done in-place. +{func}`~geoutils.Raster.crop` returns a new Raster. For more details, see the {ref}`specific section and function descriptions in the API`. ```{code-cell} ipython3 # Crop raster to smaller bounds -rast_crop = rast.crop(crop_geom=(0.3, 0.3, 1, 1), inplace=False) +rast_crop = rast.crop(crop_geom=(0.3, 0.3, 1, 1)) print(rast_crop.bounds) ``` diff --git a/doc/source/vector_class.md b/doc/source/vector_class.md index 80cc7bdf..8cc01ab4 100644 --- a/doc/source/vector_class.md +++ b/doc/source/vector_class.md @@ -165,12 +165,12 @@ See {ref}`core-match-ref` for more details. The {func}`~geoutils.Vector.crop` function can also be passed a {class}`list` or {class}`tuple` of bounds (`xmin`, `ymin`, `xmax`, `ymax`). -By default, {func}`~geoutils.Vector.crop` is done in-place and keeps all intersecting geometries. It can also be passed the `clip` argument to clip +By default, {func}`~geoutils.Vector.crop` returns a new {class}`~geoutils.Vector` which keeps all intersecting geometries. It can also be passed the `clip` argument to clip intersecting geometries to the extent. ```{code-cell} ipython3 # Crop vector to smaller bounds -vect_crop = vect.crop(crop_geom=(-73.5, -46.6, -73.4, -46.5), inplace=False, clip=True) +vect_crop = vect.crop(crop_geom=(-73.5, -46.6, -73.4, -46.5), clip=True) print(vect_crop.info()) ```