Skip to content

Commit 7532e70

Browse files
committed
Convert db command and subcommand help summaries (and other method DocBlock summaries) to use third-person singular verbs.
1 parent f040d08 commit 7532e70

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

src/DB_Command.php

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
use \WP_CLI\Utils;
44

55
/**
6-
* Perform basic database operations using credentials stored in wp-config.php
6+
* Performs basic database operations using credentials stored in wp-config.php.
77
*
88
* ## EXAMPLES
99
*
@@ -27,7 +27,7 @@
2727
class DB_Command extends WP_CLI_Command {
2828

2929
/**
30-
* Create a new database.
30+
* Creates a new database.
3131
*
3232
* Runs `CREATE_DATABASE` SQL statement using `DB_HOST`, `DB_NAME`,
3333
* `DB_USER` and `DB_PASSWORD` database credentials specified in
@@ -46,7 +46,7 @@ public function create( $_, $assoc_args ) {
4646
}
4747

4848
/**
49-
* Delete the existing database.
49+
* Deletes the existing database.
5050
*
5151
* Runs `DROP_DATABASE` SQL statement using `DB_HOST`, `DB_NAME`,
5252
* `DB_USER` and `DB_PASSWORD` database credentials specified in
@@ -71,7 +71,7 @@ public function drop( $_, $assoc_args ) {
7171
}
7272

7373
/**
74-
* Remove all tables from the database.
74+
* Removes all tables from the database.
7575
*
7676
* Runs `DROP_DATABASE` and `CREATE_DATABASE` SQL statements using
7777
* `DB_HOST`, `DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials
@@ -97,7 +97,7 @@ public function reset( $_, $assoc_args ) {
9797
}
9898

9999
/**
100-
* Check the current status of the database.
100+
* Checks the current status of the database.
101101
*
102102
* Runs `mysqlcheck` utility with `--check` using `DB_HOST`,
103103
* `DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials
@@ -120,7 +120,7 @@ public function check() {
120120
}
121121

122122
/**
123-
* Optimize the database.
123+
* Optimizes the database.
124124
*
125125
* Runs `mysqlcheck` utility with `--optimize=true` using `DB_HOST`,
126126
* `DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials
@@ -143,7 +143,7 @@ public function optimize() {
143143
}
144144

145145
/**
146-
* Repair the database.
146+
* Repairs the database.
147147
*
148148
* Runs `mysqlcheck` utility with `--repair=true` using `DB_HOST`,
149149
* `DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials
@@ -166,7 +166,7 @@ public function repair() {
166166
}
167167

168168
/**
169-
* Open a MySQL console using credentials from wp-config.php
169+
* Opens a MySQL console using credentials from wp-config.php
170170
*
171171
* ## OPTIONS
172172
*
@@ -196,7 +196,7 @@ public function cli( $args, $assoc_args ) {
196196
}
197197

198198
/**
199-
* Execute a SQL query against the database.
199+
* Executes a SQL query against the database.
200200
*
201201
* Executes an arbitrary SQL query using `DB_HOST`, `DB_NAME`, `DB_USER`
202202
* and `DB_PASSWORD` database credentials specified in wp-config.php.
@@ -374,7 +374,7 @@ public function export( $args, $assoc_args ) {
374374
}
375375

376376
/**
377-
* Import a database from a file or from STDIN.
377+
* Imports a database from a file or from STDIN.
378378
*
379379
* Runs SQL queries using `DB_HOST`, `DB_NAME`, `DB_USER` and
380380
* `DB_PASSWORD` database credentials specified in wp-config.php. This
@@ -424,7 +424,7 @@ public function import( $args, $assoc_args ) {
424424
}
425425

426426
/**
427-
* List the database tables.
427+
* Lists the database tables.
428428
*
429429
* Defaults to all tables registered to the $wpdb database handler.
430430
*
@@ -495,7 +495,7 @@ public function tables( $args, $assoc_args ) {
495495
}
496496

497497
/**
498-
* Display the database name and size.
498+
* Displays the database name and size.
499499
*
500500
* Display the database name and size for `DB_NAME` specified in wp-config.php.
501501
* The size defaults to a human-readable number.
@@ -671,7 +671,7 @@ public function size( $args, $assoc_args ) {
671671
}
672672

673673
/**
674-
* Display the database table prefix.
674+
* Displays the database table prefix.
675675
*
676676
* Display the database table prefix, as defined by the database handler's interpretation of the current site.
677677
*
@@ -689,7 +689,7 @@ public function prefix() {
689689
}
690690

691691
/**
692-
* Find a string in the database.
692+
* Finds a string in the database.
693693
*
694694
* Searches through all or a selection of database tables for a given string, Outputs colorized references to the string.
695695
*
@@ -1022,7 +1022,7 @@ private static function run( $cmd, $assoc_args = array(), $descriptors = null )
10221022
}
10231023

10241024
/**
1025-
* Get the column names of a db table differentiated into key columns and text columns and all columns.
1025+
* Gets the column names of a db table differentiated into key columns and text columns and all columns.
10261026
*
10271027
* @param string $table The table name.
10281028
* @return array A 3 element array consisting of an array of primary key column names, an array of text column names, and an array containing all column names.
@@ -1049,7 +1049,7 @@ private static function get_columns( $table ) {
10491049
}
10501050

10511051
/**
1052-
* Whether a column is considered text or not.
1052+
* Determines whether a column is considered text or not.
10531053
*
10541054
* @param string Column type.
10551055
* @bool True if text column, false otherwise.

0 commit comments

Comments
 (0)