Skip to content

Commit 6915ed8

Browse files
committed
Issue #570/#729 Update CHANGELOG.md and update doc test
1 parent 215c01c commit 6915ed8

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1414
### Changed
1515

1616
- `DataCube.save_result()` (and related methods) now return a `SaveResult`/`StacResource` object instead of another `DataCube` object to be more in line with the official `save_result` specification ([#402](https://github.com/Open-EO/openeo-python-client/issues/402), [#720](https://github.com/Open-EO/openeo-python-client/issues/720))
17-
- Deprecate `BatchJob.run_synchronous` in favor of `BatchJob.start_and_wait` and `BatchJob.download_result`
17+
- Deprecate `BatchJob.run_synchronous` in favor of `BatchJob.start_and_wait` ([#570](https://github.com/Open-EO/openeo-python-client/issues/570)).
1818

1919
### Removed
2020

openeo/rest/job.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,8 @@ def start_and_wait(
273273
:param soft_error_max: maximum number of soft errors (e.g. temporary connection glitches) to allow
274274
:param show_error_logs: whether to automatically print error logs when the batch job failed.
275275
276+
:return: Handle to the job created at the backend.
277+
276278
.. versionchanged:: 0.37.0
277279
Added argument ``show_error_logs``.
278280
"""

tests/internal/test_documentation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def test_extract_main_description():
5555
(DataCube.download, DataCube.execute_batch),
5656
(DataCube.create_job, DataCube.execute_batch),
5757
# DataCube vs BatchJob
58-
# (BatchJob.run_synchronous, DataCube.execute_batch),
58+
(BatchJob.start_and_wait, DataCube.execute_batch),
5959
# DataCube vs VectorCube
6060
(DataCube.download, VectorCube.download),
6161
(DataCube.create_job, VectorCube.create_job),

0 commit comments

Comments
 (0)