[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 Rarst):

 Replying to [comment:15 GaryJ]:
 > The top one doesn't have any delimiter (wrong), and the second does, but
 it isn't backticks so the end result isn't parsed marked up as `<code>`.
 The last one is the most correct - the doc standard needs to clarify if
 the instance of a tag needs to have angle brackets within the backticks or
 not, and then apply that consistently.

  - First one is not wrong, it's what
 [https://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#formatting-guidelines formatting guidelines]
 currently say to do in summaries.
  - Second one is tad special case since it would be too easily confused as
 English article otherwise.
  - The third case is used in descriptions, which (unlike summaries)
 currently allow markdown. Please point out if you see otherwise anywhere.

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