Details

    • Type: Sub-task Sub-task
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 1.8.0
    • Component/s: docs, fate
    • Labels:
      None

      Description

      The Repo interface is lacking java doc. For example:

      Repo.isReady return a long and there is no documentation about what its return value should be and how it is used.

      Currently it's used by Fate.run to decide whether to run "Repo.call" or not. If that's the only purpose it is used for, then isReady should return a boolean. If we do want it to return a long, then we should at least use constants by the various derived classes.

        Activity

        Hide
        Vikram Srivastava added a comment -

        After digging more - Besides deciding whether to run Repo.call, it is also used to specify sleep-times before checking the status of Repo operation. We should add this to the javadoc and use named constants as non-zero return values wherever applicable.

        Show
        Vikram Srivastava added a comment - After digging more - Besides deciding whether to run Repo.call, it is also used to specify sleep-times before checking the status of Repo operation. We should add this to the javadoc and use named constants as non-zero return values wherever applicable.

          People

          • Assignee:
            Unassigned
            Reporter:
            Vikram Srivastava
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:

              Development