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

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

Guangxian opened a new pull request #4361: KAFKA-6405:Fix incorrect comment in 
MetadataUpdater
URL: https://github.com/apache/kafka/pull/4361
 
 
   The comment for 'handleDisconnection' says it can return true or false, but 
the return type is void.
   
   ```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);
   ```
   
   change to
   ```java
       /**
        * 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.
        * @param destination
        */
       void handleDisconnection(String destination);
   ```

----------------------------------------------------------------
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:
[email protected]


> 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.
> {quote}
> /**
>      * 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);
> {quote}



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Reply via email to