run_tower: Option help text should show actual defaults

Open Beginner friendly
  • Is something wrong?
#4,308 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
cli

Research direction

Find the run_tower command’s option definitions and help text, then check how --base-case, --run-type, and --output-root defaults are determined. Update the displayed defaults to show useful actual values, and run the command’s help output to confirm all three options are informative.

Written by the indexing model from the issue text.

Description

b4b usability

Some of the default values for run_tower options are just placeholders and thus aren't useful in the help text:

  --base-case BASE_CASE_ROOT
                        Root Directory of base case build [default: None]
  --run-type {ad,postad,transient}
                        Type of run to do [default: None]

Another is technically accurate but not useful:

  --output-root OUTPUT_ROOT
                        Root output directory of cases [default: CIME_OUTPUT_ROOT as defined in cime]
Dominant language
Fortran
Stars
353
Forks
368
Avg merge
2d 15h
Merged PRs (30d)
12

Getting set up

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.

More from ESCOMP/CTSM

All issues in ESCOMP/CTSM

Similar issues

More CLI issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.