8343819: Link Float.NaN and Double.NaN to equivalence discussion in Double

[eirbjo]

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.

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8343819: Link Float.NaN and Double.NaN to equivalence discussion in Double (Enhancement - P4)

Reviewers

• Joe Darcy (@jddarcy - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/21972/head:pull/21972
$ git checkout pull/21972

Update a local copy of the PR:
$ git checkout pull/21972
$ git pull https://git.openjdk.org/jdk.git pull/21972/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 21972

View PR using the GUI difftool:
$ git pr show -t 21972

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/21972.diff

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back eirbjo! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@eirbjo This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8343819: Link Float.NaN and Double.NaN to equivalence discussion in Double

Reviewed-by: darcy

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 151 new commits pushed to the master branch:

• 52c0b09: 8277240: java/awt/Graphics2D/ScaledTransform/ScaledTransform.java dialog does not get disposed
• 0329855: 8343804: Show the default time zone with -XshowSettings option
• 44ec501: 8305895: Implement JEP 450: Compact Object Headers (Experimental)
• 6053962: 8343684: Test KDFDelayedProviderSyncTest.java intermittent fails didn't finish within the time-out 150
• 2fb0c1d: 8343844: Add benchmarks for superword/autovectorization in FFM BulkOperations
• 72f67fb: 8343411: Test fail on Windows due to "An established connection was aborted by the software in your host machine"
• 7d6a2f3: 8342860: Fix more NULL usage backsliding
• f6edfe5: 8343506: [s390x] multiple test failures with ubsan
• 96eed7f: 8343306: javac is failing to determine if a class and a sealed interface are disjoint
• 0c281ac: 8343754: Problemlist jdk/jfr/event/oldobject/TestShenandoah.java after JDK-8279016
• ... and 141 more: https://git.openjdk.org/jdk/compare/7404ddf24a162cff445cd0a26aec446461988bc8...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[openjdk]

@eirbjo The following label will be automatically applied to this pull request:

• core-libs

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 00: Full (7bb38120)

[jddarcy]

Looks fine; thanks.

[eirbjo]

/integrate

[openjdk]

Going to push as commit 8a69893.
Since your change was applied there have been 151 commits pushed to the master branch:

• 52c0b09: 8277240: java/awt/Graphics2D/ScaledTransform/ScaledTransform.java dialog does not get disposed
• 0329855: 8343804: Show the default time zone with -XshowSettings option
• 44ec501: 8305895: Implement JEP 450: Compact Object Headers (Experimental)
• 6053962: 8343684: Test KDFDelayedProviderSyncTest.java intermittent fails didn't finish within the time-out 150
• 2fb0c1d: 8343844: Add benchmarks for superword/autovectorization in FFM BulkOperations
• 72f67fb: 8343411: Test fail on Windows due to "An established connection was aborted by the software in your host machine"
• 7d6a2f3: 8342860: Fix more NULL usage backsliding
• f6edfe5: 8343506: [s390x] multiple test failures with ubsan
• 96eed7f: 8343306: javac is failing to determine if a class and a sealed interface are disjoint
• 0c281ac: 8343754: Problemlist jdk/jfr/event/oldobject/TestShenandoah.java after JDK-8279016
• ... and 141 more: https://git.openjdk.org/jdk/compare/7404ddf24a162cff445cd0a26aec446461988bc8...master

Your commit was automatically rebased without conflicts.

[openjdk]

@eirbjo Pushed as commit 8a69893.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.