Changeset 47060 for trunk/src/wp-includes/wp-db.php

Timestamp:

01/11/2020 06:30:58 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696].

See #48303.

File:

• trunk/src/wp-includes/wp-db.php (modified) (3 diffs)

trunk/src/wp-includes/wp-db.php

@@ -1436 +1436 @@
      *
      * @since 0.71
-     * @global array $EZSQL_ERROR Stores error information of query and error string
-     *
-     * @param string $str The error to display
-     * @return false|void False if the showing of errors is disabled.
+     * @global array $EZSQL_ERROR Stores error information of query and error string.
+     *
+     * @param string $str The error to display.
+     * @return void|false Void if the showing of errors is enabled, false if disabled.
      */
     public function print_error( $str = '' ) {
@@ -3412 +3412 @@
      * @since 1.5.0
      *
-     * @return float Total time spent on the query, in seconds
+     * @return float Total time spent on the query, in seconds.
      */
     public function timer_stop() {
@@ -3425 +3425 @@
      * @since 1.5.0
      *
-     * @param string $message    The Error message
-     * @param string $error_code Optional. A Computer readable string to identify the error.
-     * @return false|void
+     * @param string $message    The error message.
+     * @param string $error_code Optional. A computer-readable string to identify the error.
+     * @return void|false Void if the showing of errors is enabled, false if disabled.
      */
     public function bail( $message, $error_code = '500' ) {