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

WordPress Trac noreply at wordpress.org
Tue Feb 14 16:10:27 UTC 2023


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

 * status:  accepted => closed
 * resolution:   => fixed


Comment:

 In [changeset:"55337" 55337]:
 {{{
 #!CommitTicketReference repository="" revision="55337"
 Tests: Merge file-level and class-level DocBlocks in various unit test
 files.

 Per the [https://developer.wordpress.org/coding-standards/inline-
 documentation-standards/php/#6-file-headers documentation standards],
 whenever possible, all WordPress files should contain a header DocBlock,
 regardless of the file’s contents – this includes files containing
 classes.

 However, this recommendation makes less sense for unit test classes if not
 applied consistently, and the duplicate tags cause some confusion.

 This commit aims to reduce confusion and avoid repeating information by
 combining the DocBlocks.

 Follow-up to [40607], [43183], [43291], [43292], [43499], [43568],
 [44502], [44535], [44628], [44786], [44824], [44906], [44909], [46175].

 Props wojtekn, antonvlasenko, arafatjamil01, hztyfoon, mukesh27, costdev,
 jamilbd07, robinwpdeveloper, SergeyBiryukov.
 Fixes #57099.
 }}}

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


More information about the wp-trac mailing list