Github user hanm commented on a diff in the pull request:
https://github.com/apache/zookeeper/pull/143#discussion_r95032230
--- Diff: src/java/main/org/apache/zookeeper/ZooKeeper.java ---
@@ -127,7 +127,13 @@
* EventNone and state sKeeperStateDisconnected.
*
*/
-public class ZooKeeper {
+// We suppress the "try" warning here because the close() method's
signature
--- End diff --
Good point on avoiding mixing implementation comments with end user facing
documents. Though in this case it is safe to use block comments as @eribeiro
pointed out because block comments (enclosed in '/* */') will not be part of
java doc (enclosed in '/** */'), also use block comments provide better visual
consistency style with reset of multi line comments in src file.
It might also be helpful to add to Java doc on ZooKeeper.close so user
aware that since 3.5.3 they could optionally use try-with-resource on ZooKeeper
object without explicitly invoking close method.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
