Changeset 46985 for trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php

Timestamp:

12/18/2019 12:17:54 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Various documentation fixes for unit test factories.

See #48303.

File:

• trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php (modified) (3 diffs)

trunk/tests/phpunit/includes/factory/class-wp-unittest-factory-for-comment.php

@@ -37 +37 @@
      * Updates a comment.
      *
-     * @param int   $comment_id The comment id.
+     * @param int   $comment_id The comment ID.
      * @param array $fields     The comment details.
      *
@@ -48 +48 @@
 
     /**
-     * Creates multiple comments on given post.
+     * Creates multiple comments on a given post.
      *
-     * @param int   $post_id                The post id to create comments for.
+     * @param int   $post_id                ID of the post to create comments for.
      * @param int   $count                  Total amount of comments to create.
      * @param array $args                   The comment details.
      * @param null  $generation_definitions Default values.
      *
-     * @return int[] Array with the comment ids.
+     * @return int[] Array with the comment IDs.
      */
     public function create_post_comments( $post_id, $count = 1, $args = array(), $generation_definitions = null ) {
@@ -63 +63 @@
 
     /**
-     * Returns a comment.
+     * Retrieves a comment by a given ID.
      *
-     * @param int $comment_id The comment id.
+     * @param int $comment_id ID of the comment to retrieve.
      *
-     * @return null|WP_Comment WP_Comment when found, null when not found.
+     * @return WP_Comment|null WP_Comment object on success, null on failure.
      */
     public function get_object_by_id( $comment_id ) {