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

eolivelli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git


The following commit(s) were added to refs/heads/master by this push:
     new fc0c115  Fix javadoc for getAllBookies in RegistrationClient interface
fc0c115 is described below

commit fc0c1151908dd2c296ffb6d66e5c3f546558dd4d
Author: Michael Marshall <[email protected]>
AuthorDate: Tue Feb 9 00:36:43 2021 -0700

    Fix javadoc for getAllBookies in RegistrationClient interface
    
    Descriptions of the changes in this PR:
    
    Basic javadoc update from what looks to be an accidental copy from another 
javadoc.
    
    I opened https://github.com/apache/bookkeeper/issues/2588 to clarify what 
the meaning of "all" is. Either way, I'm sure we just need to update the 
javadoc as I did in this PR.
    
    If https://github.com/apache/bookkeeper/issues/2588 reveals something 
interesting, it might be worth updating this javadoc to include that 
information.
    
    
    Reviewers: Enrico Olivelli <[email protected]>
    
    This closes #2589 from michaeljmarshall/fix-get-all-bookies-javadoc
---
 .../main/java/org/apache/bookkeeper/discover/RegistrationClient.java    | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git 
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/discover/RegistrationClient.java
 
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/discover/RegistrationClient.java
index 96cc035..e9fbc4e 100644
--- 
a/bookkeeper-server/src/main/java/org/apache/bookkeeper/discover/RegistrationClient.java
+++ 
b/bookkeeper-server/src/main/java/org/apache/bookkeeper/discover/RegistrationClient.java
@@ -58,7 +58,7 @@ public interface RegistrationClient extends AutoCloseable {
     /**
      * Get the list of all bookies identifiers.
      *
-     * @return a future represents the list of writable bookies.
+     * @return a future represents the list of all bookies.
      */
     CompletableFuture<Versioned<Set<BookieId>>> getAllBookies();
 

Reply via email to