RFR: 8325001: Typo in the javadocs for the Arena::ofShared method
Maurizio Cimadamore
mcimadamore at openjdk.org
Thu Feb 1 12:23:09 UTC 2024
On Wed, 31 Jan 2024 14:52:58 GMT, Maurizio Cimadamore <mcimadamore at openjdk.org> wrote:
>> src/java.base/share/classes/java/lang/foreign/Arena.java line 261:
>>
>>> 259:
>>> 260: /**
>>> 261: * {@return a new shared arena} Segments allocated with the shared arena can be
>>
>> Suggestion:
>>
>> * {@return a new shared arena} Segments allocated with a shared arena can be
>
> There is a similar issue in the javadoc of `ofConfined`, which also uses `the` instead of `a`.
Also, I have noted that the javadoc of `ofAuto` uses a different style - instead of saying "segments allocated with an automatic arena", it says "segments allocated with the returned arena" (in more places). So perhaps we should make these more consistent?
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/17653#discussion_r1472944597
More information about the core-libs-dev
mailing list