Skip to content

Commit 14e501f

Browse files
committed
[Console] Improve the description of command options
1 parent d28b6c4 commit 14e501f

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

console/input.rst

+7
Original file line numberDiff line numberDiff line change
@@ -134,10 +134,17 @@ how many times in a row the message should be printed::
134134
$this
135135
// ...
136136
->addOption(
137+
// this is the name that users must type to pass this option (e.g. --iterations=5)
137138
'iterations',
139+
// this is the optional shortcut of the option name, which usually is just a letter
140+
// (e.g. `i`, so users pass it as `-i`); use it for commonly used options
141+
// or options with long names
138142
null,
143+
// this is the type of option (e.g. requires a value, can be passed more than once, etc.)
139144
InputOption::VALUE_REQUIRED,
145+
// the option description displayed when showing the command help
140146
'How many times should the message be printed?',
147+
// the default value of the option (for those which allow to pass values)
141148
1
142149
)
143150
;

0 commit comments

Comments
 (0)