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

WordPress Trac noreply at wordpress.org
Mon Nov 24 05:18:57 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:"30538"]:
 {{{
 #!CommitTicketReference repository="" revision="30538"
 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:
 * Remove HTML tag from parameter description in `comment_form()`
 * Remove HTML tag from a summary for the `comment_form_top` hook
 * Markdown-indent a code snippet in the description for
 `get_linkobjectsbyname()`
 * Markdown-indent a code snippet and format an unordered list in the
 description for `get_linkobjects()`
 * Backtick-escape some inline code in the description for `clean_pre()`
 * Remove HTML tag from the summary for the `rss_tag_pre` hook
 * Various formatting fixes in the descriptions for
 `get_filesystem_method()` and `request_filesystem_credentials()`

 Props rarst for the initial patch.
 See #30473.
 }}}

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


More information about the wp-trac mailing list