[Console] Improve description for the help flag. #38347
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I am currently trying to improve a CLI tool called
robo
(https://robo.li) that relies heavily on the console component.First thing I did was running it without any argument like
./robo
to find the description for the help flag-h
or--help
"Display this help message"
This is typical for any CLI tool out there except that when I run
./robo --help
I get the help for thelist
command (same output asrobo help list
).One of the options I considered was to fix this behavior by showing the same output when no command is given disregarding the help flag (just for the case of no command given) but I actually like how symfony console handles the help flag.
I think it needs a clarification for the description given so I changed it to:
Which is more descriptive about what actually happens in the code when that flag is given. Specially the "this" word can be a little confusing.