[wp-trac] [WordPress Trac] #58459: Replace multiple single line comments with multi-line comments

WordPress Trac noreply at wordpress.org
Mon Jun 5 18:23:50 UTC 2023


#58459: Replace multiple single line comments with multi-line comments
-----------------------------------+-------------------------------------
 Reporter:  costdev                |       Owner:  audrasjb
     Type:  enhancement            |      Status:  reviewing
 Priority:  normal                 |   Milestone:  6.3
Component:  General                |     Version:
 Severity:  normal                 |  Resolution:
 Keywords:  2nd-opinion has-patch  |     Focuses:  docs, coding-standards
-----------------------------------+-------------------------------------

Comment (by costdev):

 @audrasjb Thanks! I split the PRs into groups of 20 files to try to make
 the review process a bit smoother 🙂

 The **Language** section states:
  A function, hook, class, or method is a third-person singular element,
 meaning that third-person singular verbs should be used to describe what
 each does.

 So I think the third-person singular verbs are just for those docblocks
 rather than inline comments, right?

 We could certainly correct things like missing `.`, capitalization and
 typos on the touched comments. That way, we don't need to wait until
 someone just happens to spot those issues.

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


More information about the wp-trac mailing list