Changeset 60112

Timestamp:

03/31/2025 09:21:05 PM (4 weeks ago)

Author:

SergeyBiryukov

Message:

Docs: Merge file-level and class-level DocBlocks in wp_get_canonical_url() test file.

Per the ​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.

File:

• trunk/tests/phpunit/tests/link/wpGetCanonicalUrl.php (modified) (11 diffs)

trunk/tests/phpunit/tests/link/wpGetCanonicalUrl.php

@@ -2 +2 @@
 /**
  * Tests for the wp_get_canonical_url() function.
- *
- * @package WordPress
- * @subpackage Link
- */
-
-/**
- * Class for Testing the wp_get_canonical_url() function.
  *
  * @group link
@@ -15 +8 @@
  */
 class Tests_Link_WpGetCanonicalUrl extends WP_UnitTestCase {
+
     /**
      * The ID of the post.
@@ -52 +46 @@
 
     /**
-     * Test for a non existing post.
+     * Tests that false is returned for a non-existing post.
      */
     public function test_non_existing_post() {
@@ -59 +53 @@
 
     /**
-     * Test for a post that is not published.
+     * Tests that false is returned for a post that is not published.
      */
     public function test_post_status() {
@@ -72 +66 @@
 
     /**
-     * Test for a page that is not the queried object.
+     * Tests canonical URL for a page that is not the queried object.
      */
     public function test_non_current_page() {
@@ -79 +73 @@
 
     /**
-     * Test non permalink structure page usage.
+     * Tests non-permalink structure page usage.
      */
     public function test_paged_with_plain_permalink_structure() {
@@ -103 +97 @@
 
     /**
-     * Test permalink structure page usage.
+     * Tests permalink structure page usage.
      */
     public function test_paged_with_custom_permalink_structure() {
@@ -125 +119 @@
 
     /**
-     *  Test non permalink structure comment page usage.
+     * Tests non-permalink structure comment page usage.
      */
     public function test_comments_paged_with_plain_permalink_structure() {
@@ -151 +145 @@
 
     /**
-     * Test permalink structure comment page usage.
+     * Tests permalink structure comment page usage.
      */
     public function test_comments_paged_with_pretty_permalink_structure() {
@@ -175 +169 @@
 
     /**
-     * This test ensures that attachments with 'inherit' status properly receive a canonical URL.
+     * Tests that attachments with 'inherit' status properly receive a canonical URL.
      *
      * @ticket 63041
@@ -188 +182 @@
 
     /**
-     * Test calling of filter.
+     * Tests calling of filter.
      */
     public function test_get_canonical_url_filter() {