[helix] 11/19: Changed method doc for releaseLock in HelixLock interface

[jx...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jxue pushed a commit to branch distributed-lock
in repository https://gitbox.apache.org/repos/asf/helix.git

commit 33bceca0b6151b47da2cda1a65be140d53ad5eb8
Author: Molly Gao <mg...@mgao-mn1.linkedin.biz>
AuthorDate: Thu Feb 6 12:02:00 2020 -0800

    Changed method doc for releaseLock in HelixLock interface
---
 helix-lock/src/main/java/org/apache/helix/lock/HelixLock.java | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/helix-lock/src/main/java/org/apache/helix/lock/HelixLock.java b/helix-lock/src/main/java/org/apache/helix/lock/HelixLock.java
index 2d7e318..ec425f6 100644
--- a/helix-lock/src/main/java/org/apache/helix/lock/HelixLock.java
+++ b/helix-lock/src/main/java/org/apache/helix/lock/HelixLock.java
@@ -32,9 +32,8 @@ public interface HelixLock {
 
   /**
    * Blocking call to release a lock
-   * @return true if the lock was successfully released,
-   * false if the locked is not locked or is not locked by the user,
-   * or the lock could not be released
+   * @return true if the lock was successfully released or if the locked is not currently locked,
+   * false if the lock is not locked by the user or the release operation failed
    */
   boolean releaseLock();