Open-EO / Open-EO/openeo-python-client
Eliminate confusing job option and format option handling in `create_job` (and related)
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 217
- Forks
- 56
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 2
Description
@mbuchhorn pointed me to this snippet from doc:
https://github.com/Open-EO/openeo-python-client/blob/7c321be49bcf6f1dbd091f5f4f4ea1c0163ed7e5/docs/cookbook/sampling.md?plain=1#L37-L42
I find this extremely confusing: the sample_by_feature looks like a job option this way, while the kwargs will be passed as format option:
https://github.com/Open-EO/openeo-python-client/blob/7c321be49bcf6f1dbd091f5f4f4ea1c0163ed7e5/openeo/rest/datacube.py#L2411-L2423
Note that there is a dedicated argument job_options for the job options, but the kwargs argument goes to format options, which is an optional feature here actually. I think we should get rid of this backwards argument handling
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/cookbook/sampling.md and openeo/rest/datacube.py around create_job, especially the handling of job_options and kwargs. Trace the related argument paths, then clarify the intended separation between job options and format options and update the documentation and API behavior consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100