desihub / desihub/desispec

add 'default' in `--help`

Open
#760 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
42
Forks
26
Avg merge
1d 21h
Merged PRs (30d)
15

Description

In the current scripts, for example `/py/desispec/scripts/preproc.py`, `desi_preproc --help` does not give the default values. This can be easily fixed by adding `formatter_class=argparse.ArgumentDefaultsHelpFormatter,` in each `argparse.ArgumentParser(`.
This allows not to have to dig into the code to get some useful information.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with /py/desispec/scripts/preproc.py and inspect the argparse.ArgumentParser calls in the current scripts. Run desi_preproc --help before and after the change to verify that each help output includes argument default values; done means the affected scripts consistently use the requested formatter.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.