Skip to content

Minor docblock improvements #5929

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swissspidy merged 3 commits into from
Apr 12, 2024
Merged

Minor docblock improvements #5929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
44f73d1
Update AutoloaderStep.php
Chintesh Apr 11, 2024
c186b8d
Update IncludeFallbackAutoloader.php
Chintesh Apr 11, 2024
298de06
Update Subcommand.php
Chintesh Apr 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion php/WP_CLI/Bootstrap/AutoloaderStep.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public function process( BootstrapState $state ) {
$autoloader_paths = $this->get_autoloader_paths();

if ( false === $autoloader_paths ) {
// Skip this autoloading step.
// Skip this autoload step.
return $state;
}

Expand Down
3 changes: 1 addition & 2 deletions php/WP_CLI/Bootstrap/IncludeFallbackAutoloader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ final class IncludeFallbackAutoloader extends AutoloaderStep {
/**
* Get the autoloader paths to scan for an autoloader.
*
* @return string[]|false Array of strings with autoloader paths, or false
* to skip.
* @return string[] Array of autoloader paths, or an empty array if none are found.
*/
protected function get_autoloader_paths() {
$autoloader_paths = [
Expand Down
2 changes: 1 addition & 1 deletion php/WP_CLI/Dispatcher/Subcommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Copy Markdown
Member

@BrianHenryIE BrianHenryIE Apr 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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[].

Copy link
Copy Markdown
Contributor Author

@Chintesh Chintesh Apr 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @BrianHenryIE

Extra space has been removed. It is phpcs fix

*
* @return array Array of parameter names
*/
Expand Down