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

Some processes are documented, some are "hidden"

Open
#284 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
217
Forks
56
Avg merge
1d 22h
Merged PRs (30d)
2

Description

So due to the fact that there are some processes specifically documented and some are only available through the "generic way", people seem to think some processes are not available.

So it seems people are looking at e.g. https://open-eo.github.io/openeo-python-client/api.html#openeo.rest.datacube.DataCube for processes and don't find all processes they expect and then don't understand that they have to switch to using the generic way ( https://open-eo.github.io/openeo-python-client/processes.html#generic-api-for-adding-processes ). Instead, they seem to think that the other processes are not available (or not documented) as they don't find the process specifically mentioned in the client docs while they find some other specific processes.

How can this be improved?

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 comparing the DataCube API documentation with the generic API for adding processes at the two linked documentation pages. Improve the documentation so users can see which processes have dedicated methods and how to use all other processes generically; done means the availability distinction is clear.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.