zookeeper-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ZOOKEEPER-2818) Improve the ZooKeeper#setACL java doc
Date Mon, 26 Jun 2017 23:39:00 GMT

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

ASF GitHub Bot commented on ZOOKEEPER-2818:
-------------------------------------------

Github user hanm commented on a diff in the pull request:

    https://github.com/apache/zookeeper/pull/291#discussion_r124148111
  
    --- Diff: src/java/main/org/apache/zookeeper/ZooKeeper.java ---
    @@ -2347,25 +2347,25 @@ public void getACL(final String path, Stat stat, ACLCallback cb,
     
         /**
          * Set the ACL for the node of the given path if such a node exists and the
    -     * given version matches the version of the node. Return the stat of the
    +     * given aclVersion matches the aclVersion of the node. Return the stat of the
          * node.
          * <p>
          * A KeeperException with error code KeeperException.NoNode will be thrown
          * if no node with the given path exists.
          * <p>
          * A KeeperException with error code KeeperException.BadVersion will be
    -     * thrown if the given version does not match the node's version.
    +     * thrown if the given aclVersion does not match the node's aclVersion.
          *
          * @param path
          * @param acl
    -     * @param version
    +     * @param aclVersion
    --- End diff --
    
    I think we can add documentation to the other parameters as part of this JIRA as the additional
work required does not justify creating another JIRA which brings overheads for both of us.


> Improve the ZooKeeper#setACL  java doc
> --------------------------------------
>
>                 Key: ZOOKEEPER-2818
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-2818
>             Project: ZooKeeper
>          Issue Type: Bug
>            Reporter: Brahma Reddy Battula
>
> As per discussion in [mailinglist|http://mail-archives.apache.org/mod_mbox/zookeeper-user/201706.mbox/browser],It's
better improve Java doc or argument which might not mislead for new users.



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

Mime
View raw message