Open-EO / Open-EO/openeo-python-client

job manager: rename `start_job` callable to `create_job`

Open
#647 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

clean up documentation job manager technical debt usability
Dominant language
Python
Stars
217
Forks
56
Avg merge
1d 22h
Merged PRs (30d)
2

Description

MultiBackendJobManager.run_jobs has a start_job callable to create a job and, as suggested by its name, to start it too.
However, blindly starting each job on creation is actually an anti-pattern with the job manager (which knows better when to start jobs, based on capacity).

We should rename start_job to create_job to make the better usage pattern more obvious

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading MultiBackendJobManager.run_jobs and searching the repository for the start_job callable and its references. Rename the callable to create_job consistently, then run the relevant test suite or checks to confirm job creation and scheduling behavior remain unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.