Changeset 36822

Timestamp:

03/03/2016 07:10:58 AM (11 years ago)

Author:

DrewAPicture

Message:

Docs: Improve documentation for WP_Upgrader::release_lock(), introduced in [36349].

See #34878. See #35986.

File:

• trunk/src/wp-admin/includes/class-wp-upgrader.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-upgrader.php

@@ -800 +800 @@
 
         /**
-         * Release a lock created by `WP_Upgrader::create_lock()`.
+         * Releases an upgrader lock.
          *
          * @since 4.5.0
          * @access public
          * @static
+         *
+         * @see WP_Upgrader::create_lock()
          *
          * @param string $lock_name The name of this unique lock.
-         * @return bool
+         * @return bool True if the lock was successfully released. False on failure.
          */
         public static function release_lock( $lock_name ) {