MetOffice / MetOffice/lfric-baf
Supporting --no flags
Nobody has claimed this yet.
- Dominant language
- Fortran
- Stars
- 2
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
While we have --mpi and --no-mpi flags (and same for openmp), the help message is useles:
--mpi, -mpi Enable MPI (default: True)
--no-mpi, -no-mpi Disable MPI (default: True)
So it's not clear what the default actually is from that :(
There are some answers for similar issues in:
https://stackoverflow.com/questions/34735831/python-argparse-toggle-no-toggle-flag
https://stackoverflow.com/questions/9234258/in-python-argparse-is-it-possible-to-have-paired-no-something-something-arg
See if we can improve the definition of the arguments to get better help messages.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Find the argument definitions for --mpi/--no-mpi and the corresponding OpenMP flags, then inspect their generated help output. Improve the definitions so each paired flag communicates the actual default clearly, and verify that the help text no longer shows contradictory defaults.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100