Merge pull request #251 from ernilambar/update-command-docs

swissspidy · web-flow · commit d1ef1de31d8b · 2024-03-04T10:57:54.000+01:00
Update core commands docs
diff --git a/README.md b/README.md
@@ -205,19 +205,21 @@ Determines whether WordPress is installed by checking if the standard
 database tables are installed. Doesn't produce output; uses exit codes
 to communicate whether WordPress is installed.
 
+**OPTIONS**
+
 	[--network]
 		Check if this is a multisite installation.
 
 **EXAMPLES**
 
-    # Bash script for checking if WordPress is not installed
+    # Bash script for checking if WordPress is not installed.
 
     if ! wp core is-installed 2>/dev/null; then
         # WP is not installed. Let's try installing it.
         wp core install
     fi
 
-    # Bash script for checking if WordPress is installed, with fallback
+    # Bash script for checking if WordPress is installed, with fallback.
 
     if wp core is-installed 2>/dev/null; then
         # WP is installed. Let's do some things we should only do in a confirmed WP environment.
@@ -408,6 +410,8 @@ Runs the WordPress database update procedure.
 wp core update-db [--network] [--dry-run]
 ~~~
 
+**OPTIONS**
+
 	[--network]
 		Update databases for all sites on a network
 
@@ -416,14 +420,14 @@ wp core update-db [--network] [--dry-run]
 
 **EXAMPLES**
 
-    # Update the WordPress database
+    # Update the WordPress database.
     $ wp core update-db
     Success: WordPress database upgraded successfully from db version 36686 to 35700.
 
-    # Update databases for all sites on a network
+    # Update databases for all sites on a network.
     $ wp core update-db --network
     WordPress database upgraded successfully from db version 35700 to 29630 on example.com/
-    Success: WordPress database upgraded on 123/123 sites
+    Success: WordPress database upgraded on 123/123 sites.
 
 
 
diff --git a/src/Core_Command.php b/src/Core_Command.php
@@ -346,19 +346,21 @@ function () use ( $temp ) {
 	 * database tables are installed. Doesn't produce output; uses exit codes
 	 * to communicate whether WordPress is installed.
 	 *
+	 * ## OPTIONS
+	 *
 	 * [--network]
 	 * : Check if this is a multisite installation.
 	 *
 	 * ## EXAMPLES
 	 *
-	 *     # Bash script for checking if WordPress is not installed
+	 *     # Bash script for checking if WordPress is not installed.
 	 *
 	 *     if ! wp core is-installed 2>/dev/null; then
 	 *         # WP is not installed. Let's try installing it.
 	 *         wp core install
 	 *     fi
 	 *
-	 *     # Bash script for checking if WordPress is installed, with fallback
+	 *     # Bash script for checking if WordPress is installed, with fallback.
 	 *
 	 *     if wp core is-installed 2>/dev/null; then
 	 *         # WP is installed. Let's do some things we should only do in a confirmed WP environment.
@@ -367,7 +369,6 @@ function () use ( $temp ) {
 	 *         # Fallback if WP is not installed.
 	 *         echo 'Hey Friend, you are in the wrong spot. Move in to your WordPress directory and try again.'
 	 *     fi
-
 	 *
 	 * @subcommand is-installed
 	 */
@@ -1223,6 +1224,8 @@ public function update( $args, $assoc_args ) {
 	/**
 	 * Runs the WordPress database update procedure.
 	 *
+	 * ## OPTIONS
+	 *
 	 * [--network]
 	 * : Update databases for all sites on a network
 	 *
@@ -1231,14 +1234,14 @@ public function update( $args, $assoc_args ) {
 	 *
 	 * ## EXAMPLES
 	 *
-	 *     # Update the WordPress database
+	 *     # Update the WordPress database.
 	 *     $ wp core update-db
 	 *     Success: WordPress database upgraded successfully from db version 36686 to 35700.
 	 *
-	 *     # Update databases for all sites on a network
+	 *     # Update databases for all sites on a network.
 	 *     $ wp core update-db --network
 	 *     WordPress database upgraded successfully from db version 35700 to 29630 on example.com/
-	 *     Success: WordPress database upgraded on 123/123 sites
+	 *     Success: WordPress database upgraded on 123/123 sites.
 	 *
 	 * @subcommand update-db
 	 */

Original file line number	Diff line number	Diff line change
`@@ -346,19 +346,21 @@ function () use ( $temp ) {`
`346`	`346`	`* database tables are installed. Doesn't produce output; uses exit codes`
`347`	`347`	`* to communicate whether WordPress is installed.`
`348`	`348`	`*`
	`349`	`+ * ## OPTIONS`
	`350`	`+ *`
`349`	`351`	`* [--network]`
`350`	`352`	`* : Check if this is a multisite installation.`
`351`	`353`	`*`
`352`	`354`	`* ## EXAMPLES`
`353`	`355`	`*`
`354`		`- * # Bash script for checking if WordPress is not installed`
	`356`	`+ * # Bash script for checking if WordPress is not installed.`
`355`	`357`	`*`
`356`	`358`	`* if ! wp core is-installed 2>/dev/null; then`
`357`	`359`	`* # WP is not installed. Let's try installing it.`
`358`	`360`	`* wp core install`
`359`	`361`	`* fi`
`360`	`362`	`*`
`361`		`- * # Bash script for checking if WordPress is installed, with fallback`
	`363`	`+ * # Bash script for checking if WordPress is installed, with fallback.`
`362`	`364`	`*`
`363`	`365`	`* if wp core is-installed 2>/dev/null; then`
`364`	`366`	`* # WP is installed. Let's do some things we should only do in a confirmed WP environment.`
`@@ -367,7 +369,6 @@ function () use ( $temp ) {`
`367`	`369`	`* # Fallback if WP is not installed.`
`368`	`370`	`* echo 'Hey Friend, you are in the wrong spot. Move in to your WordPress directory and try again.'`
`369`	`371`	`* fi`
`370`		`-`
`371`	`372`	`*`
`372`	`373`	`* @subcommand is-installed`
`373`	`374`	`*/`
`@@ -1223,6 +1224,8 @@ public function update( $args, $assoc_args ) {`
`1223`	`1224`	`/**`
`1224`	`1225`	`* Runs the WordPress database update procedure.`
`1225`	`1226`	`*`
	`1227`	`+ * ## OPTIONS`
	`1228`	`+ *`
`1226`	`1229`	`* [--network]`
`1227`	`1230`	`* : Update databases for all sites on a network`
`1228`	`1231`	`*`
`@@ -1231,14 +1234,14 @@ public function update( $args, $assoc_args ) {`
`1231`	`1234`	`*`
`1232`	`1235`	`* ## EXAMPLES`
`1233`	`1236`	`*`
`1234`		`- * # Update the WordPress database`
	`1237`	`+ * # Update the WordPress database.`
`1235`	`1238`	`* $ wp core update-db`
`1236`	`1239`	`* Success: WordPress database upgraded successfully from db version 36686 to 35700.`
`1237`	`1240`	`*`
`1238`		`- * # Update databases for all sites on a network`
	`1241`	`+ * # Update databases for all sites on a network.`
`1239`	`1242`	`* $ wp core update-db --network`
`1240`	`1243`	`* WordPress database upgraded successfully from db version 35700 to 29630 on example.com/`
`1241`		`- * Success: WordPress database upgraded on 123/123 sites`
	`1244`	`+ * Success: WordPress database upgraded on 123/123 sites.`
`1242`	`1245`	`*`
`1243`	`1246`	`* @subcommand update-db`
`1244`	`1247`	`*/`