[wp-trac] [WordPress Trac] #54198: Missing short description in doc comment

[WordPress Trac]

#54198: Missing short description in doc comment
----------------------------+-------------------------------------
 Reporter:  yagniksangani   |       Owner:  (none)
     Type:  enhancement     |      Status:  closed
 Priority:  normal          |   Milestone:
Component:  Bootstrap/Load  |     Version:
 Severity:  normal          |  Resolution:  invalid
 Keywords:  has-patch       |     Focuses:  docs, coding-standards
----------------------------+-------------------------------------
Changes (by SergeyBiryukov):

 * status:  new => closed
 * resolution:   => invalid
 * milestone:  Awaiting Review =>


Comment:

 Hi there, thanks for the patch! Sorry it took a while for someone to get
 back to you.

 I believe this fragment is correct as is, it only and specifically
 describes the globals. Since it's not a class method or a function
 DocBlock, it does not need a short description as per the
 [https://developer.wordpress.org/coding-standards/inline-documentation-
 standards/php/ documentation standards].

 It is also worth noting that similar fragments also exist in other files,
 so if the standards are reconsidered at some point, this should be
 addressed in a consistent way and not just in a single file.

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