[Console] Improved rendering of optional arguments in command synopsis #26417
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
Current rendering: ``` build [options] [--] [<file>] [<output-dir>] [<packages>]... ``` Fixed (and actually correct) rendering: ``` build [options] [--] [<file> [<output-dir> [<packages>...]]] ``` Also dropped duplicating required array-type argument. There's just no need for that, it only confuses the reader.
nicolas-grekas
approved these changes
Mar 14, 2018
fabpot
approved these changes
Mar 15, 2018
|
Thank you @AnrDaemon. |
fabpot
added a commit
that referenced
this pull request
Mar 15, 2018
…mmand synopsis (AnrDaemon) This PR was squashed before being merged into the 4.1-dev branch (closes #26417). Discussion ---------- [Console] Improved rendering of optional arguments in command synopsis Current rendering: ``` build [options] [--] [<file>] [<output-dir>] [<packages>]... ``` Fixed (and actually correct) rendering: ``` build [options] [--] [<file> [<output-dir> [<packages>...]]] ``` Also dropped duplicating required array-type argument. There's just no need for that, it only confuses the reader. | Q | A | ------------- | --- | Branch? | master | Bug fix? | yes and no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | -- | License | MIT | Doc PR | -- Optional arguments can not be independent, in general. Neither the argument parser allows that. Commits ------- 938012f [Console] Improved rendering of optional arguments in command synopsis
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.
Current rendering:
Fixed (and actually correct) rendering:
Also dropped duplicating required array-type argument. There's just no need for that, it only confuses the reader.
Optional arguments can not be independent, in general. Neither the argument parser allows that.