xcube-dev / xcube-dev/xcube

"xcube grid" tool needs revison

Open
#175 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
230
Forks
21
Avg merge
2d 2h
Merged PRs (30d)
7

Description

Is your feature request related to a problem? Please describe.
xcube grid documentation is not clear and the help section of CLI is not easy to understand. Also it has changed over time and some parameters are not existing anymore, which are used in the examples. Therefore the examples do not work when executing them on the command line.

This tool should be understandable, because it is important for the cube generation process.

Describe the solution you'd like
TBD.

Contributor guide

Open the contributing guide

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 locating the xcube grid documentation, CLI help text, and command examples, then run the current help output and examples to identify obsolete parameters. Done means the help and documentation are understandable, and the documented examples execute successfully with the current tool.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.