Skip to content

Reworded the explanation about optional command options #5009

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 14, 2015
Merged

Reworded the explanation about optional command options #5009

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b5fcf0
Reworded the explanation about optional command options
javiereguiluz Feb 18, 2015
221597a
Reworded the explanation about "optional options"
javiereguiluz Feb 20, 2015
89029cd
Reworded again the note about "optional options"
javiereguiluz Feb 20, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions components/console/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,9 +296,11 @@ declare a one-letter shortcut that you can call with a single dash like

.. tip::

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*,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-1 on the term "optional option", options are always optional. It's the value we are talking about here

which is 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``).
In both cases the value retrieved for the option will be the same ``null``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me try again :)

There is nothing forbidding you to create a command with an option that optionally accepts a value. However, there is no way you can distinguish when the option was used without a values (command --yell) or when it wasn't used at all (command). In both cases, the value retrieved for the option will be null.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 (but with "without a value")

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your suggestions. It's much better now.


For example, add a new option to the command that can be used to specify
how many times in a row the message should be printed::
Expand Down