MetOffice / MetOffice/CSET

cset bake doesn't document the variables option

Open
#534 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Python
Stars
33
Forks
19
Avg merge
1d 22h
Merged PRs (30d)
30

Description

### What problem does your feature request solve?

Command line `cset bake` doesn't really document the variables options in its help text.

### Describe the solution you'd like

The help text, and accompanying documentation should be updated.

### Describe alternatives you've considered

Currently it does print out what variables are needed after reading a recipe, but that does not help someone learning the first time.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the Python entry point and help text for the `cset bake` command, then find the accompanying documentation for its variables option. Review how the command currently reports required variables after reading a recipe, and update the help and documentation so users can understand the option before running a recipe.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.