Reworded the explanation about optional command options #5009
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
Member
javiereguiluz
commented
Feb 18, 2015
| Q | A |
|---|---|
| Doc fix? | yes |
| New docs? | no |
| Applies to | 2.3+ |
| Fixed tickets | #4110 |
| It is also possible to make an option *optionally* accept a value (so that | ||
| ``--yell``, ``--yell=loud`` or ``--yell loud`` work). Options can also be configured to | ||
| accept an array of values. | ||
| It may look that it's possible to make an option *optionally* accept a value |
There was a problem hiding this comment.
the option optionally here sounds very confusing, can it be reworded too?
There was a problem hiding this comment.
I can't come up with anything else... (btw, you're back reviewing, awesome!).
There was a problem hiding this comment.
We can remove it all together and say:
There is nothing forbidding you to create a command with an input option set to
InputOption::OPTIONAL mode. You will just not be able to distinguish when the
flag for that option was used without a value (``command --yell``) or when it was
not used at all (``command``). The value retrieved for the option will be the
same ``null``.?
There was a problem hiding this comment.
I like your explanation ... but I've tweaked some minor parts of it. Thanks.
| It is also possible to make an option *optionally* accept a value (so that | ||
| ``--yell``, ``--yell=loud`` or ``--yell loud`` work). Options can also be configured to | ||
| accept an array of values. | ||
| There is nothing forbidding you to create a command with an *optional option*, |
There was a problem hiding this comment.
-1 on the term "optional option", options are always optional. It's the value we are talking about here
|
Looks good 👍 |
| It is also possible to make an option *optionally* accept a value (so that | ||
| ``--yell``, ``--yell=loud`` or ``--yell loud`` work). Options can also be configured to | ||
| accept an array of values. | ||
| There is nothing forbidding you to create a command with an option that |
There was a problem hiding this comment.
that optionally again 👴, it is okay, i will not fuss again about that. Go ahead 👍
|
👍 Thanks Javier :) |
weaverryan
added a commit
that referenced
this pull request
Mar 14, 2015
…viereguiluz) This PR was merged into the 2.3 branch. Discussion ---------- Reworded the explanation about optional command options | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | 2.3+ | Fixed tickets | #4110 Commits ------- 89029cd Reworded again the note about "optional options" 221597a Reworded the explanation about "optional options" 1b5fcf0 Reworded the explanation about optional command options
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.