Make WordPress Core


Ignore:
Timestamp:
11/24/2014 06:14:03 AM (11 years ago)
Author:
DrewAPicture
Message:

Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented.

Affects DocBlocks for the following core elements:

  • Backtick-escape HTML tags in several argument descriptions for wp_link_pages()
  • Remove an HTML tag from the summary for prepend_attachment()
  • Backtick-escape inline code in the description for get_extended()
  • Backtick-escape inline code in the description for get_post_type_labels()
  • Various markdown formatting in the description for add_rewrite_endpoint()
  • Markdown-indent a code snippet in the file header for wp-includes/shortcodes.php
  • Markdown-indent code snippets in the description for `add_shortcode()

Props rarst.
See #30473.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/post-template.php

    r30157 r30545  
    731731 *     Optional. Array or string of default arguments.
    732732 *
    733  *     @type string       $before           HTML or text to prepend to each link. Default is '<p> Pages:'.
    734  *     @type string       $after            HTML or text to append to each link. Default is '</p>'.
    735  *     @type string       $link_before      HTML or text to prepend to each link, inside the <a> tag.
     733 *     @type string       $before           HTML or text to prepend to each link. Default is `<p> Pages:`.
     734 *     @type string       $after            HTML or text to append to each link. Default is `</p>`.
     735 *     @type string       $link_before      HTML or text to prepend to each link, inside the `<a>` tag.
    736736 *                                          Also prepended to the current item, which is not linked. Default empty.
    737  *     @type string       $link_after       HTML or text to append to each Pages link inside the <a> tag.
     737 *     @type string       $link_after       HTML or text to append to each Pages link inside the `<a>` tag.
    738738 *                                          Also appended to the current item, which is not linked. Default empty.
    739739 *     @type string       $next_or_number   Indicates whether page numbers should be used. Valid values are number
     
    15111511
    15121512/**
    1513  * Wrap attachment in <<p>> element before content.
     1513 * Wrap attachment in paragraph tag before content.
    15141514 *
    15151515 * @since 2.0.0
Note: See TracChangeset for help on using the changeset viewer.