Uploaded image for project: 'Accumulo'
  1. Accumulo
  2. ACCUMULO-2590

Update public API in readme to clarify what's included

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Blocker
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.6.0
    • Component/s: docs
    • Labels:
      None

      Description

      Due to confusion expressed on the mailing list, edit the README section on the public API to make unambiguous:

      1. the list of packages included (e.g. "all packages under org.apache.accumulo.core.client, save those named 'impl'")
      2. that public Classes and Interfaces in those packages are covered
      3. that within said Classes and Interfaces, we include
        1. public and protected members
        2. public and protected methods
        3. public and protected constructors
        4. public and protected inner Classes and Interfaces

      And that "compatibility" means binary compatibility as defined in the Java Language Spec v3, Chapter 13

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                busbey Sean Busbey
                Reporter:
                busbey Sean Busbey
              • Votes:
                0 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: