Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8367704

Fix minor documentation issues in java.time.**

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: P4 P4
    • tbd
    • 26
    • core-libs

      Please review this documentation-only change, which I believe does NOT require CSR.

      The change touches java.time.** classes that I happen to have been using a lot recently. While the diff is pretty self-describing, here's the summary of what I did:

      used a comma separator for some big integer values, to improve readability;
      fixed a few typos and grammar.
      While I'm open to discuss the change, I also have some questions. Note: I'm not attempting to address those questions in this PR.

      What's the significance of the second argument in Duration.between(Temporal, Temporal) being exclusive? For example, would the result of the following call be different if the second argument was inclusive?

        Duration.between(Instant.ofEpochSecond(1), Instant.ofEpochSecond(2))
      Are there any cases here where that distinction matters?

      In many cases, the following phrase is used throughout documentation:

      positive or negative

      While the intent is clearly to stress the directed nature of values, shouldn't we -- for completeness -- also mention zero where applicable?

      What's the significance of title-case for Java Time-Scale? FWIW, the documentation also uses "Java time-scale".

            prappo Pavel Rappo
            prappo Pavel Rappo
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: