Changeset 47017

Timestamp:

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

Author:

SergeyBiryukov

Message:

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

See #48303.

Location:

trunk

Files:

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

trunk/src/wp-includes/comment.php

@@ -2317 +2317 @@
  *
  * @param array $commentarr Contains information on the comment.
- * @return int Comment was updated if value is 1, or was not updated if value is 0.
+ * @return int The value 1 if the comment was updated, 0 if not updated.
  */
 function wp_update_comment( $commentarr ) {

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 ) {