[Console] Doc Block: More intuitive usage example in ArrayInput. #30319
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
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.
fabpot
approved these changes
Feb 21, 2019
Member
|
Thank you @mattjanssen. |
fabpot
added a commit
that referenced
this pull request
Feb 21, 2019
…ayInput. (mattjanssen) 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Make the ArrayInput doc block example more self-explanatory and less misleading. Show the common use case of having
command, and replace the confusingnameargument with something more arbitrary.The current doc block example for
ArrayInputseems to imply that the command name goes in asname, but this is actually just a random argument, named "name", in this case.It might be more helpful to provide an example that works with Symfony's
Consolecomponent out of the box, as that is a common use case: