Minor docblock improvements #5929
Merged
Conversation
This file contains 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
| @@ -506,7 +506,7 @@ public function invoke( $args, $assoc_args, $extra_args ) { | |||
| * Get an array of parameter names, by merging the command-specific and the | |||
| * global parameters. | |||
| * | |||
| * @param array $spec Optional. Specification of the current command. | |||
| * @param array $spec Optional. Specification of the current command. | |||
There was a problem hiding this comment.
This looks to be array{name:array<string>} as its shape. Obviously, the $spec array probably has much more, but that's the part this function needs.
The return type looks to be string[].
There was a problem hiding this comment.
Thanks @BrianHenryIE
Extra space has been removed. It is phpcs fix
swissspidy
changed the title
swissspidy
approved these changes
Apr 12, 2024
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 pull request improves function comments for enhanced clarity and documentation within the codebase. The updates aim to provide clear explanations of function behaviors and parameters, improving readability and maintainability. Thank you for reviewing this contribution.