[wp-trac] [WordPress Trac] #48397: PHPDoc correction for wptexturize() in wp-includes/formatting.php

[WordPress Trac]

#48397: PHPDoc correction for wptexturize() in wp-includes/formatting.php
--------------------------+-----------------------------
 Reporter:  atachibana    |      Owner:  (none)
     Type:  defect (bug)  |     Status:  new
 Priority:  normal        |  Milestone:  Awaiting Review
Component:  General       |    Version:
 Severity:  minor         |   Keywords:
  Focuses:  docs          |
--------------------------+-----------------------------
 Enhanced missing information of Codex for add_help_tab() in wp-
 admin/includes/class-wp-screen.php:
 - Function description
 - since 4.0 information
 Other missing information in Notes section were added to Code Reference as
 'More Information'.

 Codex: https://codex.wordpress.org/Function_Reference/wptexturize
 Code Reference:
 https://developer.wordpress.org/reference/functions/wptexturize/

 This is the action of inline docs and Codex migration initiatives.

 {{{
 Index: formatting.php
 ===================================================================
 --- formatting.php      (revision 46568)
 +++ formatting.php      (working copy)
 @@ -10,6 +10,8 @@
  /**
   * Replaces common plain text characters into formatted entities
   *
 + * This returns given text with transformations of quotes to smart
 quotes,
 + * apostrophes, dashes, ellipses, the trademark symbol, and the
 multiplication symbol.
   * As an example,
   *
   *     'cause today's effort makes it worth tomorrow's "holiday" ...
 @@ -23,6 +25,7 @@
   * Do not use this function before the {@see 'init'} action hook;
 everything will break.
   *
   * @since 0.71
 + * @since 4.0  Revised to improve performance and to resolve many bugs.
 Added the run_wptexturize filter to allow a theme or plugin to permanently
 disable this feature.
   *
   * @global array $wp_cockneyreplace Array of formatted entities for
 certain common phrases
   * @global array $shortcode_tags
 }}}

-- 
Ticket URL: <https://core.trac.wordpress.org/ticket/48397>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform