From a72e3a5635b9971111857910f41deb71e0e89e7a Mon Sep 17 00:00:00 2001 From: Elien Vandermaesen Date: Thu, 9 Jan 2025 08:40:10 +0100 Subject: [PATCH] issue #678 improve documentation --- openeo/rest/connection.py | 4 ++-- openeo/rest/datacube.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/openeo/rest/connection.py b/openeo/rest/connection.py index 0c80cedb9..615b13f3d 100644 --- a/openeo/rest/connection.py +++ b/openeo/rest/connection.py @@ -1271,7 +1271,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. @@ -1296,7 +1296,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, diff --git a/openeo/rest/datacube.py b/openeo/rest/datacube.py index d21b3847a..1de00ac3a 100644 --- a/openeo/rest/datacube.py +++ b/openeo/rest/datacube.py @@ -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. @@ -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)