[wp-trac] [WordPress Trac] #54746: Comment Error in wp-login.php

[WordPress Trac]

#54746: Comment Error in wp-login.php
------------------------------------+-------------------------------------
 Reporter:  alkesh7                 |       Owner:  SergeyBiryukov
     Type:  enhancement             |      Status:  assigned
 Priority:  normal                  |   Milestone:  6.0
Component:  Login and Registration  |     Version:
 Severity:  minor                   |  Resolution:
 Keywords:                          |     Focuses:  docs, coding-standards
------------------------------------+-------------------------------------
Changes (by peterwilsoncc):

 * keywords:  has-patch =>
 * owner:  peterwilsoncc => SergeyBiryukov
 * status:  reopened => assigned


Comment:

 Replying to [comment:8 SergeyBiryukov]:
 > I think comments like "Main" have some benefit, as they denote various
 parts of the file, in this case separating function declarations from the
 main part.

 With the additional context they do, on it's own the word main is
 meaningless.

 > Instead of removing them, I think we can convert them to the multi-line
 format per the documentation standards:
 > {{{
 > /*
 >  * Main.
 >  */
 > }}}

 The point is to meet the coding standards by avoiding single line comments
 of that format. Given that the additional context is needed for the
 comment to make sense, I think it best revised as a multi-line comment
 anyway.

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