Merge branch '4.4' into 5.4

javiereguiluz · javiereguiluz · commit 90fb661b3c91 · 2022-07-22T11:07:23.000+02:00
* 4.4:
  [Console] Improve the description of command options
diff --git a/console/input.rst b/console/input.rst
@@ -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 (e.g. --iterations=5)
             'iterations',
+            // this is the optional shortcut of the option name, which usually is just a letter
+            // (e.g. `i`, so users pass it as `-i`); use it for commonly used options
+            // or options with long names
             null,
+            // this is the type of option (e.g. requires a value, can be passed more than once, etc.)
             InputOption::VALUE_REQUIRED,
+            // the option description displayed when showing the command help
             'How many times should the message be printed?',
+            // the default value of the option (for those which allow to pass values)
             1
         )
     ;

Original file line number	Diff line number	Diff line change
`@@ -134,10 +134,17 @@ how many times in a row the message should be printed::`
`134`	`134`	`$this`
`135`	`135`	`// ...`
`136`	`136`	`->addOption(`
	`137`	`+ // this is the name that users must type to pass this option (e.g. --iterations=5)`
`137`	`138`	`'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`
`138`	`142`	`null,`
	`143`	`+ // this is the type of option (e.g. requires a value, can be passed more than once, etc.)`
`139`	`144`	`InputOption::VALUE_REQUIRED,`
	`145`	`+ // the option description displayed when showing the command help`
`140`	`146`	`'How many times should the message be printed?',`
	`147`	`+ // the default value of the option (for those which allow to pass values)`
`141`	`148`	`1`
`142`	`149`	`)`
`143`	`150`	`;`