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

Closed

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

  • JDK-8344367: Fix mistakes in FX API docs (Bug - P4)(⚠️ The fixVersion in this issue is [jfx24] but the fixVersion in .jcheck/conf is jfx25, a new backport will be created when this pr is integrated.)

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, kcr, 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 1 new commit pushed to the master branch:

  • 3ce3af0: 8348100: Tooltips cannot be instantiated on background thread

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
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.

@mstr2
Copy link
Collaborator

mstr2 commented Dec 6, 2024

cssref.html L2038:
<td>apples when the mnemonic affordance (typically an underscore)

@bridgekeeper
Copy link

bridgekeeper bot commented Jan 3, 2025

@nlisker This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

@openjdk
Copy link

openjdk bot commented Jan 25, 2025

@nlisker this pull request can not be integrated into master due to one or more merge conflicts. To resolve these merge conflicts and update this pull request you can run the following commands in the local repository for your personal fork:

git checkout 8344367-Fix-mistakes-in-FX-API-docs
git fetch https://git.openjdk.org/jfx.git master
git merge FETCH_HEAD
# resolve conflicts and follow the instructions given by git merge
git commit -m "Merge master"
git push

@openjdk openjdk bot added merge-conflict Pull request has merge conflict with target branch and removed ready Ready to be integrated labels Jan 25, 2025
@nlisker
Copy link
Collaborator Author

nlisker commented Jan 25, 2025

cssref.html L2038: <td>apples when the mnemonic affordance (typically an underscore)

Didn't notice that this was fixed in a bigger patch.

@openjdk openjdk bot added ready Ready to be integrated and removed merge-conflict Pull request has merge conflict with target branch labels Jan 25, 2025
@nlisker
Copy link
Collaborator Author

nlisker commented Jan 25, 2025

I think that this week is a good time to integrate this. The copyright year script should be run after this too.

@kevinrushforth
Copy link
Member

I think that this week is a good time to integrate this. The copyright year script should be run after this too.

That sounds good.

@arapte Can you file a JBS task to update the copyright years (some time during RDP2)?

@arapte
Copy link
Member

arapte commented Feb 5, 2025

I think that this week is a good time to integrate this. The copyright year script should be run after this too.

That sounds good.

@arapte Can you file a JBS task to update the copyright years (some time during RDP2)?

Created the task JDK-8349472. Shall create a PR after this is integrated.

@mstr2
Copy link
Collaborator

mstr2 commented Feb 7, 2025

Node:9099
@param timer the transition timer --> @param propertyName the CSS name of the targeted property

Node:9082
add @param propertyName the CSS name of the targeted property

@openjdk openjdk bot removed the ready Ready to be integrated label Feb 8, 2025
@openjdk openjdk bot added the ready Ready to be integrated label Feb 10, 2025
@nlisker
Copy link
Collaborator Author

nlisker commented Feb 10, 2025

/integrate

@openjdk
Copy link

openjdk bot commented Feb 10, 2025

Going to push as commit 8818ccf.
Since your change was applied there has been 1 commit pushed to the master branch:

  • 3ce3af0: 8348100: Tooltips cannot be instantiated on background thread

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Feb 10, 2025
@openjdk openjdk bot closed this Feb 10, 2025
@openjdk openjdk bot removed ready Ready to be integrated rfr Ready for review labels Feb 10, 2025
@nlisker nlisker deleted the 8344367-Fix-mistakes-in-FX-API-docs branch February 10, 2025 16:32
@openjdk
Copy link

openjdk bot commented Feb 10, 2025

@nlisker Pushed as commit 8818ccf.

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

@nlisker
Copy link
Collaborator Author

nlisker commented Feb 10, 2025

Do I need to /backport this?

@kevinrushforth
Copy link
Member

Do I need to /backport this?

Yes please. /backport :jfx24

@nlisker
Copy link
Collaborator Author

nlisker commented Feb 10, 2025

/backport :jfx24

@openjdk
Copy link

openjdk bot commented Feb 10, 2025

@nlisker the backport was successfully created on the branch backport-nlisker-8818ccf8-jfx24 in my personal fork of openjdk/jfx. To create a pull request with this backport targeting openjdk/jfx:jfx24, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit 8818ccf8 from the openjdk/jfx repository.

The commit being backported was authored by Nir Lisker on 10 Feb 2025 and was reviewed by Andy Goryachev, Kevin Rushforth and Marius Hanl.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jfx:

$ git fetch https://github.com/openjdk-bots/jfx.git backport-nlisker-8818ccf8-jfx24:backport-nlisker-8818ccf8-jfx24
$ git checkout backport-nlisker-8818ccf8-jfx24
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jfx.git backport-nlisker-8818ccf8-jfx24

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated Pull request has been integrated
Development

Successfully merging this pull request may close these issues.

6 participants