Ticket #58316: phpdoc.patch

wp-includes/formatting.php

@@ -3777 +3777 @@
 /**
  * Determines the difference between two timestamps.
  *
- * The difference is returned in a human readable format such as "1 hour",
+ * The difference is returned in a human-readable format such as "1 hour",
  * "5 mins", "2 days".
  *
  * @since 1.5.0
@@ -3785 +3785 @@
  *
  * @param int $from Unix timestamp from which the difference begins.
  * @param int $to   Optional. Unix timestamp to end the time difference. Default becomes time() if not set.
- * @return string Human readable time difference.
+ * @return string Human-readable time difference.
  */
 function human_time_diff( $from, $to = 0 ) {
         if ( empty( $to ) ) {
@@ -3846 +3846 @@
         }
 
         /**
-         * Filters the human readable difference between two timestamps.
+         * Filters the human-readable difference between two timestamps.
          *
          * @since 4.0.0
          *
-         * @param string $since The difference in human readable text.
+         * @param string $since The difference in human-readable text.
          * @param int    $diff  The difference in seconds.
          * @param int    $from  Unix timestamp from which the difference begins.
          * @param int    $to    Unix timestamp to end the time difference.
@@ -3863 +3863 @@
  *
  * Returns a maximum of 55 words with an ellipsis appended if necessary.
  *
- * The 55 word limit can be modified by plugins/themes using the {@see 'excerpt_length'} filter
+ * The 55-word limit can be modified by plugins/themes using the {@see 'excerpt_length'} filter
  * The ' […]' string can be modified by plugins/themes using the {@see 'excerpt_more'} filter
  *
  * @since 1.5.0
@@ -4305 +4305 @@
 /**
  * Performs a deep string replace operation to ensure the values in $search are no longer present.
  *
- * Repeats the replacement operation until it no longer replaces anything so as to remove "nested" values
+ * Repeats the replacement operation until it no longer replaces anything to remove "nested" values
  * e.g. $subject = '%0%0%0DDD', $search ='%0D', $result ='' rather than the '%0%0DD' that
  * str_replace would return
  *
@@ -4337 +4337 @@
  *
  * NOTE: Since 4.8.3, '%' characters will be replaced with a placeholder string,
  * this prevents certain SQLi attacks from taking place. This change in behaviour
- * may cause issues for code that expects the return value of esc_sql() to be useable
+ * may cause issues for code that expects the return value of esc_sql() to be usable
  * for other purposes.
  *
  * @since 2.8.0
@@ -5104 +5104 @@
 }
 
 /**
- * WordPress implementation of PHP sprintf() with filters.
+ * WordPress' implementation of PHP sprintf() with filters.
  *
  * @since 2.5.0
  * @since 5.3.0 Formalized the existing and already documented `...$args` parameter
@@ -5282 +5282 @@
 /**
  * Adds a base URL to relative links in passed content.
  *
- * By default it supports the 'src' and 'href' attributes. However this can be
- * changed via the 3rd param.
+ * By default, it supports the 'src' and 'href' attributes.
+ * However, this can be changed via the 3rd param.
  *
  * @since 2.7.0
  *