You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2021/09/10 16:39:53 UTC

[GitHub] [pulsar] michaeljmarshall opened a new pull request #12005: [Java Client] Fix JavaDoc for closeAsync: remove documented exception…

michaeljmarshall opened a new pull request #12005:
URL: https://github.com/apache/pulsar/pull/12005


   … that isn't thrown
   
   ## Motivation
   
   Fix JavaDoc on the PulsarClient interface.
   
   ## Changes
   
   * Switch `throws` to `return` as the method does not actually throw the checked exception
   
   ## Testing
   
   No tests needed, as this change just updates the documentation to align with the code.
   
   ## Documentation
   
   This is fixing documentation. The website does not need to be updated.
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] michaeljmarshall commented on pull request #12005: [Java Client] Fix JavaDoc for closeAsync: remove documented exception…

Posted by GitBox <gi...@apache.org>.
michaeljmarshall commented on pull request #12005:
URL: https://github.com/apache/pulsar/pull/12005#issuecomment-917165290


   /pulsarbot run-failure-checks


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] michaeljmarshall commented on pull request #12005: [Java Client] Fix JavaDoc for closeAsync: remove documented exception…

Posted by GitBox <gi...@apache.org>.
michaeljmarshall commented on pull request #12005:
URL: https://github.com/apache/pulsar/pull/12005#issuecomment-929373831


   @gaoran10 @315157973 @aahmed-se @codelipenghui - PTAL


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] michaeljmarshall commented on pull request #12005: [Java Client] Fix JavaDoc for closeAsync: remove documented exception…

Posted by GitBox <gi...@apache.org>.
michaeljmarshall commented on pull request #12005:
URL: https://github.com/apache/pulsar/pull/12005#issuecomment-929373831


   @gaoran10 @315157973 @aahmed-se @codelipenghui - PTAL


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] michaeljmarshall commented on pull request #12005: [Java Client] Fix JavaDoc for closeAsync: remove documented exception…

Posted by GitBox <gi...@apache.org>.
michaeljmarshall commented on pull request #12005:
URL: https://github.com/apache/pulsar/pull/12005#issuecomment-918553397


   > Lgtm
   > 
   > We do not have a good way to document possibile error outcomes of CompletareFuture.
   > This is a general problem for libraries that use this mechanism.
   > 
   > I am not sure if we should document anyway the fact that some kind of error may occur
   
   @eolivelli - this is a good point. We could choose to list some of the expected exceptions here. However, there won't be any compile time checks to ensure that implementations of this interface only throw documented exceptions.
   
   Since this is a generic problem that extends even beyond Pulsar, I don't think we should try to solve it in this PR. I copied the updated comment from another client interface: https://github.com/apache/pulsar/blob/e2bc52d40450fa00af258c4432a5b71d50a5c6e0/pulsar-client-api/src/main/java/org/apache/pulsar/client/api/Reader.java#L78-L83


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] michaeljmarshall commented on pull request #12005: [Java Client] Fix JavaDoc for closeAsync: remove documented exception…

Posted by GitBox <gi...@apache.org>.
michaeljmarshall commented on pull request #12005:
URL: https://github.com/apache/pulsar/pull/12005#issuecomment-917098025


   /pulsarbot run-failure-checks


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [pulsar] eolivelli merged pull request #12005: [Java Client] Fix JavaDoc for closeAsync: remove documented exception…

Posted by GitBox <gi...@apache.org>.
eolivelli merged pull request #12005:
URL: https://github.com/apache/pulsar/pull/12005


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org