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-2829) Interface usability / compatibility improvements through Java annotation.
Date Thu, 27 Jul 2017 01:42:02 GMT

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

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

Github user afine commented on the issue:

    https://github.com/apache/zookeeper/pull/316
  
    The only other change in the output of our javadoc due to this patch are extra packages
appearing in the package list in the javadoc. Those packages do not include any "Public" classes
and a user clicking on them will reveal no documented classes. This could be fixed by manually
excluding those packages in the javadoc ant task but doing so would "defeat the purpose" of
handling exclusion using the annotations. The behavior is consistent with other projects in
our ecosystem such as Hadoop and HBase.


> Interface usability / compatibility improvements through Java annotation.
> -------------------------------------------------------------------------
>
>                 Key: ZOOKEEPER-2829
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-2829
>             Project: ZooKeeper
>          Issue Type: Improvement
>          Components: java client, server
>    Affects Versions: 3.4.10, 3.5.3
>            Reporter: Michael Han
>            Assignee: Abraham Fine
>              Labels: annotation
>
> Hadoop has interface classification regarding the interfaces' scope and stability. ZK
should do something similar, which not only provides additional benefits of making API compatibility
easier between releases (or even commits, by automating the checks via some tooling), but
also consistent with rest of Hadoop ecosystem.
> See HADOOP-5073 for more context.



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

Mime
View raw message