Update handbook for release v2.4.0

wp-cli · Nov 12, 2019 · d5af0f4 · d5af0f4
1 parent 6a5aa8d
commit d5af0f4
Show file tree

Hide file tree

Showing 21 changed files with 26 additions and 19 deletions.
diff --git a/commands/cli.md b/commands/cli.md
@@ -1,6 +1,6 @@
 # wp cli
 
-Review current WP-CLI info, check for updates, or see defined aliases.
+Reviews current WP-CLI info, checks for updates, or views defined aliases.
 
 ### EXAMPLES
 

diff --git a/commands/cli/alias.md b/commands/cli/alias.md
@@ -20,7 +20,7 @@ Aliases are shorthand references to WordPress installs. For instance, `@dev` cou
     ssh: [email protected]:12345/home/dev/
 
     # Add alias.
-    $ wp cli alias add prod --set-ssh=login@host --set-path=/path/to/wordpress/install/ --set-user=wpcli
+    $ wp cli alias add @prod --set-ssh=login@host --set-path=/path/to/wordpress/install/ --set-user=wpcli
     Success: Added '@prod' alias.
 
     # Update alias.

diff --git a/commands/cli/alias/list.md b/commands/cli/alias/list.md
@@ -1,6 +1,6 @@
 # wp cli alias list
 
-List available WP-CLI aliases.
+Lists available WP-CLI aliases.
 
 ### OPTIONS
 

diff --git a/commands/cli/cache/clear.md b/commands/cli/cache/clear.md
@@ -1,6 +1,6 @@
 # wp cli cache clear
 
-Clear the internal cache.
+Clears the internal cache.
 
 ### EXAMPLES
 

diff --git a/commands/cli/cache/prune.md b/commands/cli/cache/prune.md
@@ -1,6 +1,6 @@
 # wp cli cache prune
 
-Prune the internal cache.
+Prunes the internal cache.
 
 Removes all cached files except for the newest version of each one.
 

diff --git a/commands/cli/check-update.md b/commands/cli/check-update.md
@@ -1,6 +1,6 @@
 # wp cli check-update
 
-Check to see if there is a newer version of WP-CLI available.
+Checks to see if there is a newer version of WP-CLI available.
 
 Queries the Github releases API. Returns available versions if there are updates available, or success message if using the latest release.
 

diff --git a/commands/cli/cmd-dump.md b/commands/cli/cmd-dump.md
@@ -1,6 +1,6 @@
 # wp cli cmd-dump
 
-Dump the list of installed commands, as JSON.
+Dumps the list of installed commands, as JSON.
 
 ### EXAMPLES
 

diff --git a/commands/cli/completions.md b/commands/cli/completions.md
@@ -1,6 +1,6 @@
 # wp cli completions
 
-Generate tab completion strings.
+Generates tab completion strings.
 
 ### OPTIONS
 

diff --git a/commands/cli/info.md b/commands/cli/info.md
@@ -1,6 +1,6 @@
 # wp cli info
 
-Print various details about the WP-CLI environment.
+Prints various details about the WP-CLI environment.
 
 Helpful for diagnostic purposes, this command shares:
 

diff --git a/commands/cli/param-dump.md b/commands/cli/param-dump.md
@@ -1,6 +1,6 @@
 # wp cli param-dump
 
-Dump the list of global parameters, as JSON or in var_export format.
+Dumps the list of global parameters, as JSON or in var_export format.
 
 ### OPTIONS
 

diff --git a/commands/cli/update.md b/commands/cli/update.md
@@ -1,6 +1,6 @@
 # wp cli update
 
-Update WP-CLI to the latest release.
+Updates WP-CLI to the latest release.
 
 Default behavior is to check the releases API for the newest stable version, and prompt if one is available.
 

diff --git a/commands/cli/version.md b/commands/cli/version.md
@@ -1,6 +1,6 @@
 # wp cli version
 
-Print WP-CLI version.
+Prints WP-CLI version.
 
 ### EXAMPLES
 

diff --git a/commands/core/download.md b/commands/core/download.md
@@ -6,14 +6,17 @@ Downloads and extracts WordPress core files to the specified path. Uses current
 
 ### OPTIONS
 
+[&lt;download-url&gt;]
+: Download directly from a provided URL instead of fetching the URL from the wordpress.org servers.
+
 [\--path=&lt;path&gt;]
 : Specify the path in which to install WordPress. Defaults to current directory.
 
 [\--locale=&lt;locale&gt;]
 : Select which language you want to download.
 
 [\--version=&lt;version&gt;]
-: Select which version you want to download. Accepts a version number, 'latest' or 'nightly'
+: Select which version you want to download. Accepts a version number, 'latest' or 'nightly'.
 
 [\--skip-content]
 : Download WP without the default themes and plugins.

diff --git a/commands/dist-archive.md b/commands/dist-archive.md
@@ -25,6 +25,9 @@ Use one distibution archive command for many projects, instead of a bash script
 [&lt;target&gt;]
 : Path and file name for the distribution archive. Defaults to project directory name plus version, if discoverable.
 
+[\--create-target-dir]
+: Automatically create the target directory as needed.
+
 [\--format=&lt;format&gt;]
 : Choose the format for the archive.
 \---

diff --git a/commands/help.md b/commands/help.md
@@ -1,6 +1,6 @@
 # wp help
 
-Get help on WP-CLI, or on a specific command.
+Gets help on WP-CLI, or on a specific command.
 
 ### OPTIONS
 

diff --git a/commands/plugin/list.md b/commands/plugin/list.md
@@ -45,6 +45,7 @@ These fields are optionally available:
 * update_id
 * title
 * description
+* file
 
 ### EXAMPLES
 

diff --git a/commands/post/generate.md b/commands/post/generate.md
@@ -67,7 +67,7 @@ options:
     Generating posts  100% [================================================] 0:01 / 0:04
 
     # Generate posts with fetched content.
-    $ curl http://loripsum.net/api/5 | wp post generate --post_content --count=10
+    $ curl -N http://loripsum.net/api/5 | wp post generate --post_content --count=10
       % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                      Dload  Upload   Total   Spent    Left  Speed
     100  2509  100  2509    0     0    616      0  0:00:04  0:00:04 --:--:--   616

diff --git a/commands/scaffold/plugin.md b/commands/scaffold/plugin.md
@@ -6,7 +6,7 @@ The following files are always generated:
 
 * `plugin-slug.php` is the main PHP plugin file.
 * `readme.txt` is the readme file for the plugin.
-* `package.json` needed by NPM holds various metadata relevant to the project. Packages: `grunt`, `grunt-wp-i18n` and `grunt-wp-readme-to-markdown`.
+* `package.json` needed by NPM holds various metadata relevant to the project. Packages: `grunt`, `grunt-wp-i18n` and `grunt-wp-readme-to-markdown`. Scripts: `start`, `readme`, `i18n`.
 * `Gruntfile.js` is the JS file containing Grunt tasks. Tasks: `i18n` containing `addtextdomain` and `makepot`, `readme` containing `wp_readme_to_markdown`.
 * `.editorconfig` is the configuration file for Editor.
 * `.gitignore` tells which files (or patterns) git should ignore.

diff --git a/commands/user.md b/commands/user.md
@@ -2,7 +2,7 @@
 
 Manages users, along with their roles, capabilities, and meta.
 
-See references for [Roles and Capabilities](https://wordpress.org/support/article/roles-and-capabilities/) and [WP User class](https://developer.wordpress.org/reference/classes/wp_user/).
+See references for [Roles and Capabilities](https://codex.wordpress.org/Roles_and_Capabilities) and [WP User class](https://codex.wordpress.org/Class_Reference/WP_User).
 
 ### EXAMPLES
 

diff --git a/commands/user/reset-password.md b/commands/user/reset-password.md
@@ -16,7 +16,7 @@ Resets the password for one or more users.
     $ wp user reset-password admin editor
     Reset password for admin.
     Reset password for editor.
-    Success: Passwords reset.
+    Success: Passwords reset for 2 users.
 
 ### GLOBAL PARAMETERS
 

diff --git a/internal-api/wp-cli-utils-make-progress-bar.md b/internal-api/wp-cli-utils-make-progress-bar.md
@@ -12,7 +12,7 @@ Create a progress bar to display percent completion of a given operation.
 <strong>$message</strong> (string) Text to display before the progress bar.<br />
 <strong>$count</strong> (integer) Total number of ticks to be performed.<br />
 <strong>$interval</strong> (int) Optional. The interval in milliseconds between updates. Default 100.<br />
-<strong>@return</strong> (\cli\progress\Bar|WP_CLI\NoOp) <br />
+<strong>@return</strong> (cli\progress\Bar|WP_CLI\NoOp) <br />
 </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -45,6 +45,7 @@ These fields are optionally available: @@
     * update_id
     * title
     * description
+    * file
     ### EXAMPLES
@@ Expand Down @@