Details

    • Type: Sub-task Sub-task
    • Status: Resolved
    • Priority: Major Major
    • Resolution: Won't Fix
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: client
    • Labels:
      None

      Description

      Conveying information about the stability of the API over time can be difficult.

      We should create annotations with well-defined semantics to convey information, like whether a class/method is "experimental" or "stable" or something else, and what those mean. These annotations should be well documented.

        Activity

        Hide
        Sean Busbey added a comment -

        Guava's Beta annotation would be one simple way to implement this.

        Show
        Sean Busbey added a comment - Guava's Beta annotation would be one simple way to implement this.
        Hide
        Christopher Tubbs added a comment -

        Oh, I like that. Since we're likely going to have a dependency on guava anyway in the API module. It's docs seem to define it pretty well, too. If that definition aligns with our requirements, it seems like a good idea to use it.

        Show
        Christopher Tubbs added a comment - Oh, I like that. Since we're likely going to have a dependency on guava anyway in the API module. It's docs seem to define it pretty well, too. If that definition aligns with our requirements, it seems like a good idea to use it.
        Hide
        Christopher Tubbs added a comment -

        I'm closing this as "Won't Fix". Guava's @Beta annotation satisfies every goal I had in mind for this, and in any case, API stability should be subject to project-wide guidelines.

        Show
        Christopher Tubbs added a comment - I'm closing this as "Won't Fix". Guava's @Beta annotation satisfies every goal I had in mind for this, and in any case, API stability should be subject to project-wide guidelines.

          People

          • Assignee:
            Unassigned
            Reporter:
            Christopher Tubbs
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development