[wp-trac] [WordPress Trac] #51448: Coding Standards / Doc Comments fix

WordPress Trac noreply at wordpress.org
Mon Oct 5 13:29:45 UTC 2020


#51448: Coding Standards / Doc Comments fix
-------------------------------------+-----------------------------
 Reporter:  ankitmaru                |       Owner:  (none)
     Type:  defect (bug)             |      Status:  new
 Priority:  normal                   |   Milestone:  Future Release
Component:  Upgrade/Install          |     Version:  3.7
 Severity:  minor                    |  Resolution:
 Keywords:  has-patch needs-refresh  |     Focuses:  docs
-------------------------------------+-----------------------------
Changes (by desrosj):

 * focuses:  docs, coding-standards => docs
 * severity:  normal => minor
 * component:  General => Upgrade/Install
 * version:  trunk => 3.7
 * milestone:  Awaiting Review => Future Release
 * keywords:  has-patch => has-patch needs-refresh


Comment:

 Can we also update the function's `@param` tags to include descriptions?

 Also, since this file is only ~500 lines, it would be great to audit the
 inline documentation for the entire file at the same time. At first
 glance, it looks like most of the functions have all of the required
 inline docs, but if it could be double checked, that would be great!

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


More information about the wp-trac mailing list