[wp-trac] [WordPress Trac] #63166: Docblock improvements for WP 6.9

[WordPress Trac]

#63166: Docblock improvements for WP 6.9
----------------------------+-------------------------------
 Reporter:  desrosj         |       Owner:  (none)
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  6.9
Component:  General         |     Version:
 Severity:  normal          |  Resolution:
 Keywords:                  |     Focuses:  coding-standards
----------------------------+-------------------------------

Comment (by SergeyBiryukov):

 In [changeset:"60112" 60112]:
 {{{
 #!CommitTicketReference repository="" revision="60112"
 Docs: Merge file-level and class-level DocBlocks in
 `wp_get_canonical_url()` test file.

 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.

 Includes using third-person singular verbs in test method descriptions, as
 per the documentation standards.

 Follow-up to [55337], [60108], [60109].

 See #63166.
 }}}

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