[wp-trac] [WordPress Trac] #57099: Fix Test Class Header Tags

[WordPress Trac]

#57099: Fix Test Class Header Tags
--------------------------------------+-----------------------------
 Reporter:  wojtekn                   |       Owner:  SergeyBiryukov
     Type:  enhancement               |      Status:  accepted
 Priority:  normal                    |   Milestone:  6.2
Component:  Build/Test Tools          |     Version:
 Severity:  minor                     |  Resolution:
 Keywords:  has-patch has-unit-tests  |     Focuses:
--------------------------------------+-----------------------------

Comment (by hztyfoon):

 Hey there, wojtekn 🤗
 welcome to WordPress Trac! Thanks for the ticket.


 Though the file-level DocBlock was probably created as per
 [https://developer.wordpress.org/coding-standards/inline-documentation-
 standards/php/#6-file-headers this] as sergey pointed out here:

 > It looks like the file-level DocBlock was created per the
 [https://developer.wordpress.org/coding-standards/inline-documentation-
 standards/php/#6-file-headers File Headers] section of the documentation
 standards:
 > > The file header DocBlock is used to give an overview of what is
 contained in the file.
 > >
 > > Whenever possible, all WordPress files should contain a header
 DocBlock, regardless of the file’s contents – this includes files
 containing classes.

 But, I totally agree with sergey on the duplicate tags looking confusing.
 Also [https://developer.wordpress.org/coding-standards/inline-
 documentation-standards/php/#6-file-headers this standard] is not
 consistently used with all unit test classes.

 > That said, I agree it makes less sense for unit test classes if not
 applied consistently, and the duplicate tags look a bit confusing.

 So,
 Looks to me, this ticket is good to move forward with the proposed changes
 in [attachment:"57099.diff"] which seems to be also applied in the
 [https://github.com/WordPress/wordpress-develop/pull/3614 PR] now.

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