Skip to content

Rename/deprecated BatchJob.run_synchronous #570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
soxofaan opened this issue Jun 11, 2024 · 1 comment
Closed

Rename/deprecated BatchJob.run_synchronous #570

soxofaan opened this issue Jun 11, 2024 · 1 comment

Comments

@soxofaan
Copy link
Member

def run_synchronous(
self, outputfile: Union[str, Path, None] = None,
print=print, max_poll_interval=60, connection_retry_interval=30
) -> BatchJob:
"""Start the job, wait for it to finish and download result"""

The naming of method BatchJob.run_synchronous is quite confusing:
this is not about running a batch job in synchronous mode (which is not a thing yet, but we've been thinking about doing something like that), but just about starting it and actively waiting.
There is already start_and_wait, which is named more to the point.

@jdries
Copy link
Collaborator

jdries commented Jan 3, 2025

ok, please add deprecated annotation and explain alternative in docstring

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants