minor #30319 [Console] Doc Block: More intuitive usage example in ArrayInput. (mattjanssen)

fabpot · fabpot · commit eb7a612763c1 · 2019-02-21T08:45:12.000+01:00
This PR was merged into the 3.4 branch. Discussion ---------- [Console] Doc Block: More intuitive usage example in ArrayInput. Make the ArrayInput doc block example more self-explanatory and less misleading. Show the common use case of having `command`, and replace the confusing `name` argument with something more arbitrary. | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a The current doc block example for `ArrayInput` seems to imply that the command name goes in as `name`, but this is actually just a random argument, named "name", in this case. ```php new ArrayInput(['name' => 'foo', '--bar' => 'foobar']); ``` It might be more helpful to provide an example that works with Symfony's `Console` component out of the box, as that is a common use case: ```php new ArrayInput(['command' => 'foo:bar', 'foo' => 'bar', '--bar' => 'foobar']); ``` Commits ------- 0c8d311 Update usage example in ArrayInput doc block.
diff --git a/src/Symfony/Component/Console/Input/ArrayInput.php b/src/Symfony/Component/Console/Input/ArrayInput.php
@@ -19,7 +19,7 @@
  *
  * Usage:
  *
- *     $input = new ArrayInput(['name' => 'foo', '--bar' => 'foobar']);
+ *     $input = new ArrayInput(['command' => 'foo:bar', 'foo' => 'bar', '--bar' => 'foobar']);
  *
  * @author Fabien Potencier <fabien@symfony.com>
  */

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`*`
`20`	`20`	`* Usage:`
`21`	`21`	`*`
`22`		`- * $input = new ArrayInput(['name' => 'foo', '--bar' => 'foobar']);`
	`22`	`+ * $input = new ArrayInput(['command' => 'foo:bar', 'foo' => 'bar', '--bar' => 'foobar']);`
`23`	`23`	`*`
`24`	`24`	`* @author Fabien Potencier <fabien@symfony.com>`
`25`	`25`	`*/`