RFR: 8338398: Trivially fix grammar and typos

[Pavel Rappo]

On Wed, 14 Aug 2024 21:03:05 GMT, Kevin Bourrillion <duke at openjdk.org> wrote:

>> This PR fixes a few trivial grammar issues and typos in documentation.
>> 
>> The main issue is the use of the word "timeout". To my mind, timeout, a duration, is not the same as deadline, which is a point in time, an instant, which allows "before" and "after". While one can think of timeout as of an event, which can occur, it usually expires, or elapses. An activity can also "time out" (phrasal verb).
>> 
>> I think the proposed change might read better and match wording already used throughout `java.util.concurrent.**`, for example, here:  
>> 
>> * https://github.com/openjdk/jdk/blob/00e6c63cd12e3f92d0c1d007aab4f74915616ffb/src/java.base/share/classes/java/util/concurrent/ExecutorService.java#L211-L223
>> * https://github.com/openjdk/jdk/blob/fbe4cc96e223882a18c7ff666fe6f68b3fa2cfe4/src/java.base/share/classes/java/util/concurrent/locks/AbstractQueuedSynchronizer.java#L1019-L1036 
>> 
>> @DougLea, thoughts?
>
> src/java.base/share/classes/java/util/concurrent/ForkJoinTask.java line 1075:
> 
>> 1073:     /**
>> 1074:      * Tries to join this task, returning true if it completed
>> 1075:      * (possibly exceptionally) before the given timeout elapses and
> 
> Seems like mixed tense now: do we want completes/elapses or completed/elapsed?

I admit I had doubts about the sequence of tenses too. That's a pretty complex sentence, and I'm a non-native English speaker. It's hard to re-tense it while retaining its conditional nature.

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/20584#discussion_r1717605188