Skip to content

Commit

Permalink
issue #678 improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ElienVandermaesenVITO committed Jan 9, 2025
1 parent db6bbb8 commit e9ec44d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions openeo/rest/connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -1270,7 +1270,7 @@ def load_collection(
:param collection_id: image collection identifier
:param spatial_extent: limit data to specified bounding box or polygons. Can be provided in different ways:
- a bounding box dictionary
- a shapely geometry
- a Shapely geometry object
- a GeoJSON-style dictionary,
- a path (:py:class:`str` or :py:class:`~pathlib.Path`) to a local, client-side GeoJSON file,
which will be loaded automatically to get the geometries as GeoJSON construct.
Expand All @@ -1295,7 +1295,7 @@ def load_collection(
Add :py:func:`~openeo.rest.graph_building.collection_property` support to ``properties`` argument.
.. versionchanged:: 0.37.0
Add support for shapely geometry and local path to GeoJSON file to spatial_extent argument.
Add support for passing a Shapely geometry or a local path to a GeoJSON file to the ``spatial_extent`` argument.
"""
return DataCube.load_collection(
collection_id=collection_id,
Expand Down
4 changes: 2 additions & 2 deletions openeo/rest/datacube.py
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ def load_collection(
Can be ``None`` to work without connection and collection metadata.
:param spatial_extent: limit data to specified bounding box or polygons. Can be provided in different ways:
- a bounding box dictionary
- a shapely geometry
- a Shapely geometry object
- a GeoJSON-style dictionary,
- a path (:py:class:`str` or :py:class:`~pathlib.Path`) to a local, client-side GeoJSON file,
which will be loaded automatically to get the geometries as GeoJSON construct.
Expand All @@ -185,7 +185,7 @@ def load_collection(
Add :py:func:`~openeo.rest.graph_building.collection_property` support to ``properties`` argument.
.. versionchanged:: 0.37.0
Add support for shapely geometry and local path to GeoJSON file to spatial_extent argument.
Add support for passing a Shapely geometry or a local path to a GeoJSON file to the ``spatial_extent`` argument.
"""
if temporal_extent:
temporal_extent = cls._get_temporal_extent(extent=temporal_extent)
Expand Down

0 comments on commit e9ec44d

Please sign in to comment.