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

add_dimension: infer 'type' from name?

Open
#796 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature request good first issue low hanging fruit nice-to-have usability
Dominant language
Python
Stars
217
Forks
56
Avg merge
1d 22h
Merged PRs (30d)
2

Description

Found this in an expert notebook:

cube.add_dimension(name="bands",label="coh_VV_amp")

The user clearly intended to add a dimension with type 'bands', but he got a dimension with type 'other'. This lead to subsequent hard to find bugs.

The client can do 2 things here: set the type based on the name if not set explicitly, or log a warning when this name is used but type is defaulted to 'other'.

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 from the cube.add_dimension entry point and reproduce the expert-notebook example with name="bands" and label="coh_VV_amp". Compare the behavior when type is omitted with the two proposed outcomes: infer "bands" from the name or warn when defaulting to "other"; confirm the intended choice with maintainers before defining done.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.