Skip to content

Convert core command help summaries to use third-person singular verbs. #53

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
danielbachhuber merged 3 commits into from
Dec 5, 2017
Merged

Convert core command help summaries to use third-person singular verbs. #53

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
21273c0
Use third-person singular verbs in the summary for the core command.
DrewAPicture Dec 5, 2017
6d083c4
Convert core subcommand help summaries (and other method DocBlock sum…
DrewAPicture Dec 5, 2017
5d4fa0d
Regenerate README from command description
danielbachhuber Dec 5, 2017
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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This package implements the following commands:

### wp core check-update

Check for WordPress updates via Version Check API.
Checks for WordPress updates via Version Check API.

~~~
wp core check-update [--minor] [--major] [--field=<field>] [--fields=<fields>] [--format=<format>]
Expand Down Expand Up @@ -61,7 +61,7 @@ or success message when up to date.

### wp core download

Download core WordPress files.
Downloads core WordPress files.

~~~
wp core download [--path=<path>] [--locale=<locale>] [--version=<version>] [--skip-content] [--force]
Expand Down Expand Up @@ -154,7 +154,7 @@ user_login doesn't exist, a new user will be created.

### wp core is-installed

Check if WordPress is installed.
Checks if WordPress is installed.

~~~
wp core is-installed [--network]
Expand Down Expand Up @@ -223,7 +223,7 @@ for more details about how multisite works.

### wp core multisite-install

Install WordPress multisite from scratch.
Installs WordPress multisite from scratch.

~~~
wp core multisite-install [--url=<url>] [--base=<url-path>] [--subdomains] --title=<site-title> --admin_user=<username> [--admin_password=<password>] --admin_email=<email> [--skip-email] [--skip-config]
Expand Down Expand Up @@ -285,7 +285,7 @@ file with the appropriate multisite rewrite rules.

### wp core update

Update WordPress to a newer version.
Updates WordPress to a newer version.

~~~
wp core update [<zip>] [--minor] [--version=<version>] [--force] [--locale=<locale>]
Expand Down Expand Up @@ -348,7 +348,7 @@ update isn't actually running.

### wp core update-db

Run the WordPress database update procedure.
Runs the WordPress database update procedure.

~~~
wp core update-db [--network] [--dry-run]
Expand All @@ -375,7 +375,7 @@ wp core update-db [--network] [--dry-run]

### wp core version

Display the WordPress version.
Displays the WordPress version.

~~~
wp core version [--extra]
Expand Down
22 changes: 11 additions & 11 deletions src/Core_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
use \WP_CLI\Utils;

/**
* Download, install, update and manage a WordPress install.
* Downloads, installs, updates, and manages a WordPress install.
*
* ## EXAMPLES
*
Expand All @@ -28,7 +28,7 @@
class Core_Command extends WP_CLI_Command {

/**
* Check for WordPress updates via Version Check API.
* Checks for WordPress updates via Version Check API.
*
* Lists the most recent versions when there are updates available,
* or success message when up to date.
Expand Down Expand Up @@ -86,7 +86,7 @@ function check_update( $_, $assoc_args ) {
}

/**
* Download core WordPress files.
* Downloads core WordPress files.
*
* Downloads and extracts WordPress core files to the specified path. Uses
* current directory when no path is specified. Downloaded build is verified
Expand Down Expand Up @@ -293,7 +293,7 @@ private function get_download_offer( $locale ) {
}

/**
* Check if WordPress is installed.
* Checks if WordPress is installed.
*
* Determines whether WordPress is installed by checking if the standard
* database tables are installed. Doesn't produce output; uses exit codes
Expand Down Expand Up @@ -436,7 +436,7 @@ public function multisite_convert( $args, $assoc_args ) {
}

/**
* Install WordPress multisite from scratch.
* Installs WordPress multisite from scratch.
*
* Creates the WordPress tables in the database using the URL, title, and
* default admin user details provided. Then, creates the multisite tables
Expand Down Expand Up @@ -753,7 +753,7 @@ private static function get_clean_basedomain() {
}

/**
* Display the WordPress version.
* Displays the WordPress version.
*
* ## OPTIONS
*
Expand Down Expand Up @@ -805,7 +805,7 @@ public function version( $args = array(), $assoc_args = array() ) {
}

/**
* Get version information from `wp-includes/version.php`.
* Gets version information from `wp-includes/version.php`.
*
* @return array {
* @type string $wp_version The WordPress version.
Expand Down Expand Up @@ -836,7 +836,7 @@ private static function get_wp_details( $abspath = ABSPATH ) {
}

/**
* Search for the value assigned to variable `$var_name` in PHP code `$code`.
* Searches for the value assigned to variable `$var_name` in PHP code `$code`.
*
* This is equivalent to matching the `\$VAR_NAME = ([^;]+)` regular expression and returning
* the first match either as a `string` or as an `integer` (depending if it's surrounded by
Expand Down Expand Up @@ -900,7 +900,7 @@ private static function get_core_checksums( $version, $locale ) {
}

/**
* Update WordPress to a newer version.
* Updates WordPress to a newer version.
*
* Defaults to updating WordPress to the latest version.
*
Expand Down Expand Up @@ -1082,7 +1082,7 @@ public function update( $args, $assoc_args ) {
}

/**
* Run the WordPress database update procedure.
* Runs the WordPress database update procedure.
*
* [--network]
* : Update databases for all sites on a network
Expand Down Expand Up @@ -1213,7 +1213,7 @@ private function get_download_url( $version, $locale = 'en_US', $file_type = 'zi
}

/**
* Returns update information
* Returns update information.
*/
private function get_updates( $assoc_args ) {
wp_version_check();
Expand Down