Rebuild docs for v0.25.0

Author: danielbachhuber

commands/cli/alias/index.md

@@ -13,7 +13,7 @@ display_global_parameters: true
 <hr />
 
 Aliases are shorthand references to WordPress installs. For instance,
-'@dev' could refer to a development install and '@prod' could refer to
+`@dev` could refer to a development install and `@prod` could refer to
 a production install. This command gives you visibility in what
 registered aliases you have available.
 
@@ -28,5 +28,19 @@ options:
   - json
 \---
 
+### EXAMPLES
+
+    # List all available aliases.
+    $ wp cli alias
+    ---
+    @all: Run command against every registered alias.
+    @prod:
+      ssh: [email protected]~/webapps/production
+    @dev:
+      ssh: [email protected]/srv/www/runcommand.dev
+    @both:
+      - @prod
+      - @dev
+
 
 

commands/cli/check-update/index.md

@@ -15,13 +15,13 @@ display_global_parameters: true
 ### OPTIONS
 
 [\--patch]
-: Only list patch updates
+: Only list patch updates.
 
 [\--minor]
-: Only list minor updates
+: Only list minor updates.
 
 [\--major]
-: Only list major updates
+: Only list major updates.
 
 [\--field=<field>]
 : Prints the value of a single field for each update.
@@ -43,16 +43,16 @@ options:
 
 ### EXAMPLES
 
-    # Check for update
+    # Check for update.
     $ wp cli check-update
     Success: WP-CLI is at the latest version.
 
-    # Check for update and new version is available
+    # Check for update and new version is available.
     $ wp cli check-update
     +---------+-------------+-------------------------------------------------------------------------------+
     | version | update_type | package_url                                                                   |
     +---------+-------------+-------------------------------------------------------------------------------+
-    | 0.23.1  | patch       | https://github.com/wp-cli/wp-cli/releases/download/v0.23.1/wp-cli-0.23.1.phar |
+    | 0.24.1  | patch       | https://github.com/wp-cli/wp-cli/releases/download/v0.24.1/wp-cli-0.24.1.phar |
     +---------+-------------+-------------------------------------------------------------------------------+
 
 

commands/cli/cmd-dump/index.md

@@ -14,7 +14,7 @@ display_global_parameters: true
 
 ### EXAMPLES
 
-    # Dump the list of installed commands
+    # Dump the list of installed commands.
     $ wp cli cmd-dump
     {"name":"wp","description":"Manage WordPress through the command-line.","longdesc":"\n\n
 

commands/cli/index.md

@@ -14,20 +14,20 @@ display_global_parameters: true
 
 ### EXAMPLES
 
-    # Display CLI version
+    # Display CLI version.
     $ wp cli version
-    WP-CLI 0.23.1
+    WP-CLI 0.24.1
 
-    # Check for update
+    # Check for update.
     $ wp cli check-update
     Success: WP-CLI is at the latest version.
 
-    # Update CLI
+    # Update CLI.
     $ wp cli update
-    You have version 0.23.0. Would you like to update to 0.23.1? [y/n] y
-    Downloading from https://github.com/wp-cli/wp-cli/releases/download/v0.23.1/wp-cli-0.23.1.phar...
+    You have version 0.24.0. Would you like to update to 0.24.1? [y/n] y
+    Downloading from https://github.com/wp-cli/wp-cli/releases/download/v0.24.1/wp-cli-0.24.1.phar...
     New version works. Proceeding to replace.
-    Success: Updated WP-CLI to 0.23.1
+    Success: Updated WP-CLI to 0.24.1.
 
 
 
@@ -67,7 +67,7 @@ display_global_parameters: true
 		</tr>
 		<tr>
 			<td><a href="/commands/cli/update/">update</a></td>
-			<td>Fetch most recent update matching the requirements. Returns the available versions if there are updates, or empty if no update available.</td>
+			<td>Update WP-CLI.</td>
 		</tr>
 		<tr>
 			<td><a href="/commands/cli/version/">version</a></td>

commands/cli/info/index.md

@@ -25,6 +25,7 @@ options:
 
 ### EXAMPLES
 
+    # Display various data about the CLI environment.
     $ wp cli info
     PHP binary: /usr/bin/php5
     PHP version:    5.5.9-1ubuntu4.16
@@ -33,7 +34,7 @@ options:
     WP-CLI packages dir:    /home/person/.wp-cli/packages/
     WP-CLI global config:
     WP-CLI project config:
-    WP-CLI version: 0.23.1
+    WP-CLI version: 0.24.1
 
 
 

commands/cli/param-dump/index.md

@@ -28,6 +28,7 @@ options:
 
 ### EXAMPLES
 
+    # Dump the list of global parameters.
     $ wp cli param-dump --format=var_export
     array (
       'path' =>

commands/cli/update/index.md

@@ -6,36 +6,52 @@ display_global_parameters: true
 
 <small>[Commands](/commands/) &raquo; [cli](/commands/cli/) &raquo; update</small>
 
-`wp cli update` - Fetch most recent update matching the requirements. Returns the available versions if there are updates, or empty if no update available.
+`wp cli update` - Update WP-CLI.
 
 <small>Quick links: <a href="https://github.com/wp-cli/wp-cli/issues?q=is%3Aopen+label%3Acommand%3Acli-update+sort%3Aupdated-desc">Github issues</a></small>
 
 <hr />
 
+Default behavior is to check the releases API for a newer version, and
+prompt if one is available.
+
+Use `--stable` to install or reinstall the latest stable version.
+
+Use `--nightly` to install the latest built version of the master branch.
+While not recommended for production, nightly contains the latest and
+greatest, and should be stable enough for development and staging
+environments.
+
+Only works for the Phar installation mechanism.
+
 ### OPTIONS
 
 [\--patch]
-: Only perform patch updates
+: Only perform patch updates.
 
 [\--minor]
-: Only perform minor updates
+: Only perform minor updates.
 
 [\--major]
-: Only perform major updates
+: Only perform major updates.
+
+[\--stable]
+: Update to the latest stable release. Skips update check.
 
 [\--nightly]
 : Update to the latest built version of the master branch. Potentially unstable.
 
 [\--yes]
-: Do not prompt for confirmation
+: Do not prompt for confirmation.
 
 ### EXAMPLES
 
+    # Update CLI.
     $ wp cli update
-    You have version 0.23.0. Would you like to update to 0.23.1? [y/n] y
-    Downloading from https://github.com/wp-cli/wp-cli/releases/download/v0.23.1/wp-cli-0.23.1.phar...
+    You have version 0.24.0. Would you like to update to 0.24.1? [y/n] y
+    Downloading from https://github.com/wp-cli/wp-cli/releases/download/v0.24.1/wp-cli-0.24.1.phar...
     New version works. Proceeding to replace.
-    Success: Updated WP-CLI to 0.23.1
+    Success: Updated WP-CLI to 0.24.1.
 
 
 

commands/cli/version/index.md

@@ -14,8 +14,9 @@ display_global_parameters: true
 
 ### EXAMPLES
 
+    # Display CLI version.
     $ wp cli version
-    WP-CLI 0.23.1
+    WP-CLI 0.24.1
 
 
 

commands/comment/approve/index.md

@@ -19,8 +19,9 @@ display_global_parameters: true
 
 ### EXAMPLES
 
+    # Approve comment.
     $ wp comment approve 1337
-    Success: Approved comment 1337
+    Success: Approved comment 1337.
 
 
 

commands/comment/count/index.md

@@ -19,7 +19,7 @@ display_global_parameters: true
 
 ### EXAMPLES
 
-    # Count comments on whole blog
+    # Count comments on whole blog.
     $ wp comment count
     approved:        33
     spam:            3
@@ -29,7 +29,7 @@ display_global_parameters: true
     moderated:       1
     total_comments:  37
 
-    # Count comments in a post
+    # Count comments in a post.
     $ wp comment count 42
     approved:        19
     spam:            0