8336036: Synthetic documentation for a record's equals is incorrect for floating-point types

[liach]

Please review this backport of #20129 to JDK 23, fixing the documentation Javadoc generates for the default object method implementations in user records about the comparison behavior for float and double values.

---

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-8336036: Synthetic documentation for a record's equals is incorrect for floating-point types (Bug - P3)

Reviewers

• Pavel Rappo (@pavelrappo - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 20147

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

Using diff file

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

Webrev

Link to Webrev Comment

[bridgekeeper]

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

[openjdk]

@liach 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:

8336036: Synthetic documentation for a record's equals is incorrect for floating-point types

Reviewed-by: prappo

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 no new commits pushed to the jdk23 branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

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

[openjdk]

This backport pull request has now been updated with issue from the original commit.

[openjdk]

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

• javadoc

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 (d258817e)

[liach]

/integrate

[openjdk]

Going to push as commit d1373a2.
Since your change was applied there has been 1 commit pushed to the jdk23 branch:

• 0a9e3bf: 8334418: Update IANA Language Subtag Registry to Version 2024-06-14

Your commit was automatically rebased without conflicts.

[openjdk]

@liach Pushed as commit d1373a2.

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