[jira] [Commented] (KAFKA-6405) Fix incorrect comment in MetadataUpdater

["ASF GitHub Bot (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/KAFKA-6405?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16356357#comment-16356357 ] 

ASF GitHub Bot commented on KAFKA-6405:
---------------------------------------

guozhangwang closed pull request #4361: KAFKA-6405:Fix incorrect comment in MetadataUpdater
URL: https://github.com/apache/kafka/pull/4361
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/clients/src/main/java/org/apache/kafka/clients/MetadataUpdater.java b/clients/src/main/java/org/apache/kafka/clients/MetadataUpdater.java
index cb821d6a860..126728342d4 100644
--- a/clients/src/main/java/org/apache/kafka/clients/MetadataUpdater.java
+++ b/clients/src/main/java/org/apache/kafka/clients/MetadataUpdater.java
@@ -54,7 +54,7 @@
     long maybeUpdate(long now);
 
     /**
-     * If `request` is a metadata request, handles it and return `true`. Otherwise, returns `false`.
+     * Handle disconnections for metadata requests.
      *
      * This provides a mechanism for the `MetadataUpdater` implementation to use the NetworkClient instance for its own
      * requests with special handling for disconnections of such requests.
@@ -70,7 +70,7 @@
     void handleAuthenticationFailure(AuthenticationException exception);
 
     /**
-     * If `request` is a metadata request, handles it and returns `true`. Otherwise, returns `false`.
+     * Handle responses for metadata requests.
      *
      * This provides a mechanism for the `MetadataUpdater` implementation to use the NetworkClient instance for its own
      * requests with special handling for completed receives of such requests.


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


> Fix incorrect comment in MetadataUpdater
> ----------------------------------------
>
>                 Key: KAFKA-6405
>                 URL: https://issues.apache.org/jira/browse/KAFKA-6405
>             Project: Kafka
>          Issue Type: Improvement
>          Components: clients
>    Affects Versions: 1.0.0
>            Reporter: guangxian.liao
>            Priority: Trivial
>
> The comment for 'handleDisconnection' says it can return true or false, but the return type is void.
> {code:java}
> /**
>      * If `request` is a metadata request, handles it and return `true`. Otherwise, returns `false`.
>      *
>      * This provides a mechanism for the `MetadataUpdater` implementation to use the NetworkClient instance for its own
>      * requests with special handling for disconnections of such requests.
>      * @param destination
>      */
>     void handleDisconnection(String destination);
> {code}



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)