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

Timestamp:

12/27/2019 12:28:39 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve @return description for wp_update_comment() and WP_UnitTest_Factory_For_Comment::update_object().

See #48303.

File:

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

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

@@ -28 +28 @@
      * @param array $args The comment details.
      *
-     * @return false|int The comment's ID on success, false on failure.
+     * @return int|false The comment's ID on success, false on failure.
      */
     public function create_object( $args ) {
@@ -40 +40 @@
      * @param array $fields     The comment details.
      *
-     * @return int When updated 1, not update 0.
+     * @return int The value 1 if the comment was updated, 0 if not updated.
      */
     public function update_object( $comment_id, $fields ) {