[Console] Add documentation for console command attributes #15123
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
MrYamous
force-pushed
the
add-console-command-attribute
branch
from
45f9eeb to
ee18009
Compare
OskarStark
reviewed
Mar 19, 2021
|
|
||
| // the full command description shown when running the command with | ||
| // the "--help" option | ||
| ->setHelp('This command allows you to create a user...') |
There was a problem hiding this comment.
could you please add hidden and aliases in this example too?
app::new-user could be used as an alias in both examples.
Thanks
OskarStark
reviewed
Mar 19, 2021
console.rst
Outdated
|
|
||
| .. code-block:: php-attributes | ||
|
|
||
| // ... |
There was a problem hiding this comment.
Please add the use statement to ConsoleCommand
OskarStark
requested changes
Mar 19, 2021
OskarStark
reviewed
Mar 19, 2021
| // ... | ||
| protected function configure() | ||
| { | ||
| $this |
There was a problem hiding this comment.
name is missing in this example
OskarStark
reviewed
Mar 19, 2021
console.rst
Outdated
| name: 'app:create-user', | ||
| description: 'Creates a new user.' | ||
| hidden: false, | ||
| aliases: [], |
There was a problem hiding this comment.
It would be interesting how to set the help
There was a problem hiding this comment.
Currently, help isn't supported in attributes and the use of setHelp() is necessary.
Should I add it in addition to the attributes?
MrYamous
force-pushed
the
add-console-command-attribute
branch
from
ee18009 to
0af2983
Compare
|
Closing in favor of #16333. Sorry we didn't merge this one, but we hope to get more contributions from you in the future. Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is the documentation for #15003.
I don't know if it's necessary to specify that not all properties (like 'help') are supported in the attributes, or if the documentation is clear enough as is. What do you think about it?