RFR: 8310033: Clarify return value of Java Time compareTo methods [v5]
Roger Riggs
rriggs at openjdk.org
Fri Jul 7 14:40:16 UTC 2023
> In java.time packages, clarify timeline order javadoc to mention "before" and "after" in the value of the `compareTo` method return values.
> Add javadoc @see tags to isBefore and isAfter methods
>
> Replace use of "negative" and positive with "less than zero" and "greater than zero" in javadoc @return
> The term "positive" is ambiguous, zero is considered positive and indicates equality.
Roger Riggs has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains ten additional commits since the last revision:
- Improve the grammar of "the comparator value is" -> "the comparator value, that is"
Thanks for the reminder.
- Merge branch 'master' into 8310033-time-compareto
- Improve descriptions to be more specific and remove inappropriate use of before/after
Remove extra blank lines
- Clarify return values of date time classes
- Use {@code xxx} to highlight the comparison against the arg.
Update copyrights.
- Merge branch 'master' into 8310033-time-compareto
- Clarify for Duration, AbstractChronology, and Chronology
- Correct javadoc of compareInstant
- 8310033: Improve Instant.compareTo javadoc to mention before and after
Refine timeline order to mention before and after
Add javadoc @see tags to isBefore and isAfter methods
-------------
Changes:
- all: https://git.openjdk.org/jdk/pull/14479/files
- new: https://git.openjdk.org/jdk/pull/14479/files/62f01b5d..71dc98ae
Webrevs:
- full: https://webrevs.openjdk.org/?repo=jdk&pr=14479&range=04
- incr: https://webrevs.openjdk.org/?repo=jdk&pr=14479&range=03-04
Stats: 26834 lines in 1236 files changed: 13236 ins; 6372 del; 7226 mod
Patch: https://git.openjdk.org/jdk/pull/14479.diff
Fetch: git fetch https://git.openjdk.org/jdk.git pull/14479/head:pull/14479
PR: https://git.openjdk.org/jdk/pull/14479
More information about the core-libs-dev
mailing list