Skip to content

Commit bb4b448

Browse files
committed
Minor load_stac_from_job documentation tweak
1 parent cfd9f1a commit bb4b448

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

openeo/rest/connection.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1441,7 +1441,10 @@ def load_stac_from_job(
14411441
properties: Optional[Dict[str, Union[str, PGNode, Callable]]] = None,
14421442
) -> DataCube:
14431443
"""
1444-
Wrapper for :py:meth:`load_stac` that loads the result of a previous job using the STAC collection of its results.
1444+
Convenience function to directly load the results of a finished openEO job
1445+
(as a STAC collection) with :py:meth:`load_stac` in a new openEO process graph.
1446+
1447+
When available, the "canonical" link (signed URL) of the job results will be used.
14451448
14461449
:param job: a :py:class:`~openeo.rest.job.BatchJob` or job id pointing to a finished job.
14471450
Note that the :py:class:`~openeo.rest.job.BatchJob` approach allows to point
@@ -1452,6 +1455,7 @@ def load_stac_from_job(
14521455
14531456
.. versionadded:: 0.30.0
14541457
"""
1458+
# TODO #634 add option to require or avoid the canonical link
14551459
if isinstance(job, str):
14561460
job = BatchJob(job_id=job, connection=self)
14571461
elif not isinstance(job, BatchJob):

0 commit comments

Comments
 (0)