On Fri, 8 Nov 2024 10:10:28 GMT, Eirik Bjørsnøs <[email protected]> wrote:
> Please review this doc-only enhancement which links the word _equivalent_ in
> `Float.NaN` and `Double.NaN` constant field descriptions to the
> floating-point equivalence discussion in `Double`.
>
>> It is equivalent to the value returned by{@code
>> Float.intBitsToFloat(0x7fc00000)}.
>
> For readers not well-versed in floating point, it may not be immediatly clear
> what _equivalent to_ means here.
>
> The smallest improvement I could think of is to simply make the word
> `equivalent` a plain link to the floating-point equivalence discussion in the
> class description of `java.lang.Double`.
>
> Verification: This is a doc-only change. I ran `make docs` and verified that
> the links resolve.
Looks fine; thanks.
-------------
Marked as reviewed by darcy (Reviewer).
PR Review: https://git.openjdk.org/jdk/pull/21972#pullrequestreview-2425021526