Various minor doc fixes

WordPressVIPMinimum/Sniffs/Files/IncludingFileSniff.php

@@ -124,7 +124,7 @@ public function process_token( $stackPtr ) {
 
 		if ( $this->tokens[ $nextToken ]['code'] === T_STRING ) {
 			if ( in_array( $this->tokens[ $nextToken ]['content'], $this->getPathFunctions, true ) === true ) {
-				// The construct is using one of the function for getting correct path which is fine.
+				// The construct is using one of the functions for getting correct path which is fine.
 				return;
 			}
 
@@ -192,7 +192,7 @@ public function process_token( $stackPtr ) {
 	/**
 	 * Check if a content string contains a keyword in custom paths.
 	 *
-	 * @param string $content  Content string.
+	 * @param string $content Content string.
 	 *
 	 * @return bool True if the string partially matches a keyword in $allowedCustomKeywords, false otherwise.
 	 */

WordPressVIPMinimum/Sniffs/Performance/BatcacheWhitelistedParamsSniff.php

@@ -12,7 +12,7 @@
 use PHP_CodeSniffer\Util\Tokens;
 
 /**
- * Checks whether proper escaping function is used.
+ * Checks whether code tries to refer to a batcache URL parameter.
  *
  *  @package VIPCS\WordPressVIPMinimum
  */

WordPressVIPMinimum/Sniffs/Performance/CacheValueOverrideSniff.php

@@ -11,13 +11,7 @@
 use PHP_CodeSniffer\Util\Tokens;
 
 /**
- * This sniff enforces checking the return value of a function before passing it to another one.
- *
- * An example of a not checking return value is:
- *
- * <code>
- * echo esc_url( wpcom_vip_get_term_link( $term ) );
- * </code>
+ * This sniff check whether a cached value is being overridden.
  *
  * @package VIPCS\WordPressVIPMinimum
  */

WordPressVIPMinimum/Sniffs/Performance/FetchingRemoteDataSniff.php

@@ -12,7 +12,7 @@
 use PHP_CodeSniffer\Util\Tokens;
 
 /**
- * Restricts usage of rewrite rules flushing
+ * Restricts usage of file_get_contents().
  *
  *  @package VIPCS\WordPressVIPMinimum
  */

WordPressVIPMinimum/Sniffs/Performance/RemoteRequestTimeoutSniff.php

@@ -10,7 +10,7 @@
 use WordPressCS\WordPress\AbstractArrayAssignmentRestrictionsSniff;
 
 /**
- * Flag REGEXP and NOT REGEXP in meta compare
+ * Flag use of a timeout of more than 3 seconds for remote requests.
  *
  * @package VIPCS\WordPressVIPMinimum
  */

WordPressVIPMinimum/Tests/Files/IncludingFileUnitTest.inc

@@ -30,7 +30,7 @@ include_once("http://www.google.com/bad_file.php"); // External URL.
 // Allowed keywords
 include 'https://path.com/bad_file.php'; // Error - external URL with keyword from $allowedKeywords.
 require   $path; // Warning - custom variable with keyword from $allowedKeywords.
-include_once   dir_function(); // Error - custom functionm with keyword from $allowedKeywords.
+include_once   dir_function(); // Warning - custom function with keyword from $allowedKeywords.
 require CUSTOM_CONSTANT_DIR . 'file.php'; // OK.
 require_once ( VIPCS_PATH ) . 'file.php'; // OK.
 include_once