Changeset 48175 for trunk/src/wp-includes/formatting.php

Timestamp:

06/26/2020 09:28:21 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Spell "line breaks" in a consistent way.

See #49572.

File:

• trunk/src/wp-includes/formatting.php (modified) (5 diffs)

trunk/src/wp-includes/formatting.php

@@ -426 +426 @@
 
 /**
- * Replaces double line-breaks with paragraph elements.
+ * Replaces double line breaks with paragraph elements.
  *
  * A group of regex replaces used to identify text formatted with newlines and
- * replace double line-breaks with HTML paragraph tags. The remaining line-breaks
+ * replace double line breaks with HTML paragraph tags. The remaining line breaks
  * after conversion become <<br />> tags, unless $br is set to '0' or 'false'.
  *
@@ -435 +435 @@
  *
  * @param string $pee The text which has to be formatted.
- * @param bool   $br  Optional. If set, this will convert all remaining line-breaks
+ * @param bool   $br  Optional. If set, this will convert all remaining line breaks
  *                    after paragraphing. Line breaks within `<script>`, `<style>`,
  *                    and `<svg>` tags are not affected. Default true.
@@ -928 +928 @@
  *                                    double if set to 'double' or both if otherwise set.
  *                                    Default is ENT_NOQUOTES.
- * @param false|string $charset       Optional. The character encoding of the string. Default is false.
- * @param bool         $double_encode Optional. Whether to encode existing html entities. Default is false.
+ * @param false|string $charset       Optional. The character encoding of the string. Default false.
+ * @param bool         $double_encode Optional. Whether to encode existing html entities. Default false.
  * @return string The encoded text with HTML entities.
  */
@@ -1092 +1092 @@
  *
  * @param string  $string The text which is to be checked.
- * @param bool    $strip Optional. Whether to attempt to strip out invalid UTF8. Default is false.
+ * @param bool    $strip  Optional. Whether to attempt to strip out invalid UTF8. Default false.
  * @return string The checked text.
  */
@@ -3790 +3790 @@
  *
  * @param string             $text Optional. The excerpt. If set to empty, an excerpt is generated.
- * @param WP_Post|object|int $post Optional. WP_Post instance or Post ID/object. Default is null.
+ * @param WP_Post|object|int $post Optional. WP_Post instance or Post ID/object. Default null.
  * @return string The excerpt.
  */