[wp-trac] [WordPress Trac] #30473: Inline Docs: Remove invalid markup from DocBlocks

WordPress Trac noreply at wordpress.org
Mon Nov 24 06:14:05 UTC 2014


#30473: Inline Docs: Remove invalid markup from DocBlocks
--------------------------+-----------------------
 Reporter:  DrewAPicture  |       Owner:  rarst
     Type:  defect (bug)  |      Status:  assigned
 Priority:  high          |   Milestone:  4.1
Component:  General       |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:  docs
--------------------------+-----------------------

Comment (by DrewAPicture):

 In [changeset:"30545"]:
 {{{
 #!CommitTicketReference repository="" revision="30545"
 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.
 }}}

--
Ticket URL: <https://core.trac.wordpress.org/ticket/30473#comment:12>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list