From bb4b4484f296de7b7575ed42f05369daefb41d76 Mon Sep 17 00:00:00 2001 From: Stefaan Lippens Date: Thu, 26 Sep 2024 18:37:05 +0200 Subject: [PATCH] Minor `load_stac_from_job` documentation tweak --- openeo/rest/connection.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/openeo/rest/connection.py b/openeo/rest/connection.py index 13e8b6702..57089f096 100644 --- a/openeo/rest/connection.py +++ b/openeo/rest/connection.py @@ -1441,7 +1441,10 @@ def load_stac_from_job( properties: Optional[Dict[str, Union[str, PGNode, Callable]]] = None, ) -> DataCube: """ - Wrapper for :py:meth:`load_stac` that loads the result of a previous job using the STAC collection of its results. + Convenience function to directly load the results of a finished openEO job + (as a STAC collection) with :py:meth:`load_stac` in a new openEO process graph. + + When available, the "canonical" link (signed URL) of the job results will be used. :param job: a :py:class:`~openeo.rest.job.BatchJob` or job id pointing to a finished job. Note that the :py:class:`~openeo.rest.job.BatchJob` approach allows to point @@ -1452,6 +1455,7 @@ def load_stac_from_job( .. versionadded:: 0.30.0 """ + # TODO #634 add option to require or avoid the canonical link if isinstance(job, str): job = BatchJob(job_id=job, connection=self) elif not isinstance(job, BatchJob):