Misleading CLI help messages
Open
Nobody has claimed this yet.
documentation
- Dominant language
- PLpgSQL
- Stars
- 1.6k
- Forks
- 358
- Avg merge
- 20h 30m
- Merged PRs (30d)
- 27
Description
While trying to locally debug some packages which were failing on Hydra, I stumbled upon the following:
$ hydra-eval-jobs --help
error: unrecognised flag ‘--help’
Try ‘hydra-eval-jobs --help’ for more information.
$ hydra-queue-runner --help
error: unrecognised flag ‘--help’
Try ‘hydra-queue-runner --help’ for more information.
Rather minor, but it would be nice to either have more info (even if only a link to a Web page) or remove the option altogether.
Contributor guide
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
Start by running hydra-eval-jobs --help and hydra-queue-runner --help to reproduce the misleading output, then trace each command's CLI help entry point. Done means --help provides useful information, such as a web link, or is no longer advertised as an available option.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100