Open-EO / Open-EO/openeo-python-client
Update export_workspace docs on openeo.cloud
Open
Nobody has claimed this yet.
api compliancy
bug
documentation
good first issue
low hanging fruit
technical debt
usability
- Dominant language
- Python
- Stars
- 217
- Forks
- 56
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 2
Description
https://docs.openeo.cloud/workspaces/#workspace-providers suggests to use this ugly workaround for export_workspaces
result = collection.save_result().process(
"export_workspace", arguments={"workspace": WORKSPACE_NAME, "merge": None}, data=THIS
)
But that doesn't work anymore in client 0.39.0, where it should be (more user friendly):
result = collection.save_result().export_workspace(workspace=WORKSPACE_NAME)
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
Open the workspace providers page at docs.openeo.cloud/workspaces/#workspace-providers and review the export_workspaces example against the Python client 0.39.0 API. Replace the workaround with the user-friendly export_workspace call shown in the issue, then verify that the rendered documentation uses the current syntax.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100