[Console] Improve the description of command options #17006
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
94noni
reviewed
Jul 18, 2022
console/input.rst
Outdated
| 'iterations', | ||
| // this is the shortcut of the option name, which usually is just a letter |
There was a problem hiding this comment.
Suggested change
| // this is the shortcut of the option name, which usually is just a letter | |
| // this is the optional shortcut of the option name, which usually is just a letter |
console/input.rst
Outdated
| @@ -134,10 +134,17 @@ how many times in a row the message should be printed:: | |||
| $this | |||
| // ... | |||
| ->addOption( | |||
| // this is the name that users must type to pass this option | |||
There was a problem hiding this comment.
as you mentioned -I below, perhaps document here (e.g. use --iterations=5) here?
|
I did the proposed changes. Thanks Antoine! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #16648.