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

[WordPress Trac]

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

Comment (by GaryJ):

 Bad wording on my part - I didn't mean your patch was out and out wrong -
 just that the formatting guidelines in the current docs standard has some
 unfortunate inconsistencies. The fact that the special case example 2
 exists highlights that either 1 should match, or 2 should be changed to:

 * anchor element

 and that point 1 may therefore be better read as:

 * list item element

 The formatting guidelines is ambiguous as to how abbreviated element names
 should be handled as it only covers the trivial `link` example. How the
 consistency should resolved is up to the Docs team to decide, hence the
 reason I didn't write a patch.

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