On Fri, 16 Jun 2023 22:12:43 GMT, Roger Riggs <rri...@openjdk.org> wrote:
>> 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 five additional
> commits since the last revision:
>
> - 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
While the new wording is clearly an improvement, this reads weird:
> @return the comparator value is less...
For readability, I'd use _which_ or _that_, depending on your preferred
flavour/flavor of English.
@return the comparator value that is less...
-------------
PR Comment: https://git.openjdk.org/jdk/pull/14479#issuecomment-1595417780
