Merge pull request #174 from iandunn/document-regex-tokens

Document that individual text columns are searched.

Author: schlessera

src/DB_Command.php

@@ -1037,7 +1037,7 @@ public function prefix() {
 	/**
 	 * Finds a string in the database.
 	 *
-	 * Searches through all or a selection of database tables for a given string, Outputs colorized references to the string.
+	 * Searches through all of the text columns in a selection of database tables for a given string, Outputs colorized references to the string.
 	 *
 	 * Defaults to searching through all tables registered to $wpdb. On multisite, this default is limited to the tables for the current site.
 	 *
@@ -1071,7 +1071,7 @@ public function prefix() {
 	 * ---
 	 *
 	 * [--regex]
-	 * : Runs the search as a regular expression (without delimiters). The search becomes case-sensitive (i.e. no PCRE flags are added). Delimiters must be escaped if they occur in the expression.
+	 * : Runs the search as a regular expression (without delimiters). The search becomes case-sensitive (i.e. no PCRE flags are added). Delimiters must be escaped if they occur in the expression. Because the search is run on individual columns, you can use the `^` and `$` tokens to mark the start and end of a match, respectively.
 	 *
 	 * [--regex-flags=<regex-flags>]
 	 * : Pass PCRE modifiers to the regex search (e.g. 'i' for case-insensitivity).