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

WordPress Trac noreply at wordpress.org
Mon Nov 24 06:04:12 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:"30544"]:
 {{{
 #!CommitTicketReference repository="" revision="30544"
 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:
 * Markdown-indent a code snippet in the description for `wp_salt()`
 * Backtick-escape inline code in the return description for `get_avatar()`
 * Various markdown formatting in the description for `add_filter()`
 * Markdown-indent a code snippet in the description for `apply_filters()`
 * Backtick-escape inline code in the `@see` description for
 `apply_filters_ref_array()`
 * Backtick-escape inline code in the description for `do_action()`
 * Backtick-escape variables in the parameter and return descriptions for
 `do_action_ref_array()`
 * Various markdown formatting in the description for `get_plugin_data()`

 Props rarst.
 See #30473.
 }}}

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


More information about the wp-trac mailing list