Return-Path: X-Original-To: apmail-accumulo-notifications-archive@minotaur.apache.org Delivered-To: apmail-accumulo-notifications-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 7F27C11A76 for ; Fri, 28 Mar 2014 21:38:21 +0000 (UTC) Received: (qmail 11002 invoked by uid 500); 28 Mar 2014 21:38:20 -0000 Delivered-To: apmail-accumulo-notifications-archive@accumulo.apache.org Received: (qmail 10890 invoked by uid 500); 28 Mar 2014 21:38:17 -0000 Mailing-List: contact notifications-help@accumulo.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: jira@apache.org Delivered-To: mailing list notifications@accumulo.apache.org Received: (qmail 10861 invoked by uid 99); 28 Mar 2014 21:38:16 -0000 Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 28 Mar 2014 21:38:16 +0000 Date: Fri, 28 Mar 2014 21:38:16 +0000 (UTC) From: "Sean Busbey (JIRA)" To: notifications@accumulo.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Commented] (ACCUMULO-2590) Update public API in readme to clarify what's included MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 [ https://issues.apache.org/jira/browse/ACCUMULO-2590?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13951438#comment-13951438 ] Sean Busbey commented on ACCUMULO-2590: --------------------------------------- bq. Anything public or protected in an API class is part or the API. This would include methods, variables, classes, interfaces, and enums in the class. Did i miss anything? I think that's everything. I like that phrasing better as well. > Update public API in readme to clarify what's included > ------------------------------------------------------ > > Key: ACCUMULO-2590 > URL: https://issues.apache.org/jira/browse/ACCUMULO-2590 > Project: Accumulo > Issue Type: Task > Components: docs > Reporter: Sean Busbey > Priority: Blocker > Fix For: 1.6.0 > > > Due to confusion expressed on the mailing list, edit the README section on the public API to make unambiguous: > # the list of packages included (e.g. "all packages under org.apache.accumulo.core.client, save those named 'impl'") > # that public Classes and Interfaces in those packages are covered > # that within said Classes and Interfaces, we include > ## public and protected members > ## public and protected methods > ## public and protected constructors > ## public and protected inner Classes and Interfaces > And that "compatibility" means binary compatibility as defined in the [Java Language Spec v3, Chapter 13|http://docs.oracle.com/javase/specs/jls/se5.0/html/binaryComp.html] -- This message was sent by Atlassian JIRA (v6.2#6252)