Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8344367: Fix mistakes in FX API docs #1642

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

nlisker
Copy link
Collaborator

@nlisker nlisker commented Nov 17, 2024

A batch of typo and grammar fixes that were found by the spellchecker.

Integration can wait until RDP 1/2.


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

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 1642

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jfx/pull/1642.diff

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Nov 17, 2024

👋 Welcome back nlisker! 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
Copy link

openjdk bot commented Nov 17, 2024

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

8344367: Fix mistakes in FX API docs

Reviewed-by: angorya, mhanl

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 73 new commits pushed to the master branch:

  • f095868: 8341687: Memory leak in TableView after interacting with TableMenuButton
  • 3a8a559: 8344443: Deprecate FXPermission for removal
  • 35ff442: 8343196: Add build property to identify experimental builds of JavaFX
  • 7d1b2c3: 8342993: Remove uses of AccessController and AccessControlContext from JavaFX
  • dd60065: 8342997: Remove use of System::getSecurityManager and SecurityManager from JavaFX
  • b0e763c: 8344067: TableCell indices may not match the TableRow index
  • 286c3a8: 8344155: Add missing @OverRide annotation to GIFImageLoader2
  • 72af9e2: 8306707: Support pluggable image loading via javax.imageio
  • 688f7fa: 8091673: Public focus traversal API for use in custom controls
  • d0011b2: 8343760: GHA: macOS / aarch64 builds depend on Xcode 14 which will be removed
  • ... and 63 more: https://git.openjdk.org/jfx/compare/4647367ce4590440fbb85675055225c869502314...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.

@nlisker nlisker marked this pull request as ready for review November 17, 2024 21:39
@openjdk openjdk bot added the rfr Ready for review label Nov 17, 2024
@mlbridge
Copy link

mlbridge bot commented Nov 17, 2024

Webrevs

Copy link
Contributor

@andy-goryachev-oracle andy-goryachev-oracle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you for fixing these errors (from a guy who contributed at least one)!

@openjdk openjdk bot added the ready Ready to be integrated label Nov 18, 2024
@nlisker
Copy link
Collaborator Author

nlisker commented Nov 18, 2024

I will wait with integration to see what else can be accumulated until the RDPs.

@andy-goryachev-oracle
Copy link
Contributor

BTW, did you use IDE for this (and which one)?

Eclipse does highlight spelling errors inline when enabled, but I could not find a way to list all of them in the Problems view.

@nlisker
Copy link
Collaborator Author

nlisker commented Nov 20, 2024

I found some spellchecker to which you give a URL and it finds the mistakes. I needed it for something else, but then thought it could be used on the JavaDocs so I gave it a shot.

Copy link
Member

@Maran23 Maran23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The corrections look good to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready Ready to be integrated rfr Ready for review
Development

Successfully merging this pull request may close these issues.

3 participants