[wp-trac] [WordPress Trac] #34677: Inline comments for remove_accents()

[WordPress Trac]

#34677: Inline comments for remove_accents()
--------------------------+---------------------------
 Reporter:  John_Schlick  |       Owner:  DrewAPicture
     Type:  enhancement   |      Status:  reviewing
 Priority:  normal        |   Milestone:  4.6
Component:  Formatting    |     Version:  4.4
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:  docs
--------------------------+---------------------------
Changes (by DrewAPicture):

 * keywords:  needs-patch good-first-bug => has-patch
 * milestone:  Future Release => 4.6


Comment:

 Whew.

 6 hours of effort yields [attachment:34677.diff], which takes the
 suggested inline comments and formats them into markdown tables in the
 DocBlock rather than placing them inline in the code. A major downside of
 documenting them as inline comments is that the information is only really
 available to somebody reading the source code.

 Formatting into markdown tables has the benefit of being parseable for the
 Code Reference and also easily searchable from within that page. See
 [attachment:34677_output.png] for what that looks like post-parsing.

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