[wp-trac] [WordPress Trac] #58028: WP_HTML_Tag_Processor: Its reference in the Developer Resources is broken

[WordPress Trac]

#58028: WP_HTML_Tag_Processor: Its reference in the Developer Resources is broken
--------------------------+---------------------
 Reporter:  juanmaguitar  |       Owner:  (none)
     Type:  defect (bug)  |      Status:  new
 Priority:  normal        |   Milestone:  6.2.1
Component:  HTML API      |     Version:  6.2
 Severity:  normal        |  Resolution:
 Keywords:  dev-feedback  |     Focuses:  docs
--------------------------+---------------------

Comment (by coffee2code):

 I have opened up (and resolved) related tickets for:

 - phpdoc-parser: [https://github.com/WordPress/phpdoc-parser/issues/234
 Retain newlines for code blocks when the code tag has attributes]
 - wporg-developer theme: [https://github.com/WordPress/wporg-
 developer/issues/239 Properly format code blocks when the code tag has
 attributes]

 The formatting issues raised by this ticket are resolved. The parser and
 !DevHub will now properly recognize and display code blocks defined using
 code fences, including when a language is specified for the code fence.
 (Though it currently assumes all such code fences refer to PHP despite
 what may be specified.)

 '''''However''''', whether the code fences should have been used in the
 first place is a discussion for #core-docs people. Core's
 [https://developer.wordpress.org/coding-standards/inline-documentation-
 standards/php/#description inline documentation standard] indicate that
 inline code examples should be defined using an indentation of 4 spaces.

 As I see it, either that documentation should be amended to indicate that
 code fences are supported (and if so, if the language should be specified
 or not) and either recommend its usage or indicate indentation is
 recommended), ''or'' the code fences should be removed entirely.

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