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

8252389: Fix mistakes in FX API docs #380

Closed

Conversation

nlisker
Copy link
Collaborator

@nlisker nlisker commented Jan 18, 2021

The usual doc fixes (for OpenJFX 16).

Can wait until RDP2 to see if something else comes up.


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

Reviewers

Download

$ git fetch https://git.openjdk.java.net/jfx pull/380/head:pull/380
$ git checkout pull/380

@nlisker nlisker marked this pull request as ready for review Jan 18, 2021
@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Jan 18, 2021

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

@nlisker
Copy link
Collaborator Author

@nlisker nlisker commented Jan 18, 2021

/reviewers 2

@openjdk openjdk bot added the rfr label Jan 18, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Jan 18, 2021

@nlisker
The number of required reviews for this PR is now set to 2 (with at least 1 of role reviewers).

@mlbridge
Copy link

@mlbridge mlbridge bot commented Jan 18, 2021

Webrevs

@kleopatra
Copy link
Collaborator

@kleopatra kleopatra commented Jan 18, 2021

wondering how small a doc error is small enough to go into this: just noticed that Skinnable talks about "Control" in all of its methods - should be "Skinnable" everywhere (except as example implementation in overview doc), IMO. But then, the overview doc is .. lame as well, so might need its own bug anyway?

@nlisker
Copy link
Collaborator Author

@nlisker nlisker commented Jan 18, 2021

I don't mind making the "Control" -> "Skinnable" changes if you detail them, but rewriting the class doc should be it's own issue, in which case you can fix these mistakes there as well.

@kleopatra
Copy link
Collaborator

@kleopatra kleopatra commented Jan 18, 2021

thanks, that's about the lines of my thoughts as well :) Will file a separate doc bug for skinnable cleanup

@kleopatra
Copy link
Collaborator

@kleopatra kleopatra commented Jan 25, 2021

thanks, that's about the lines of my thoughts as well :) Will file a separate doc bug for skinnable cleanup

fyi: just filed https://bugs.openjdk.java.net/browse/JDK-8260364

@kevinrushforth
Copy link
Member

@kevinrushforth kevinrushforth commented Jan 29, 2021

@nlisker I'll wait to review this until after you add the fix noted in JDK-8260430.

@nlisker
Copy link
Collaborator Author

@nlisker nlisker commented Jan 29, 2021

I added a fix for JDK-8260430. Note that the underlying behavior in this class is different than that of Node. While both have a map of properties, Node uses a special key to add/get the user data to/from the map while MenuItem has a separate field for it. In Node these methods are convenience methods, but here they have a separate functionality.

@nlisker nlisker requested a review from aghaisas Jan 29, 2021
Copy link
Member

@kevinrushforth kevinrushforth left a comment

I left two additional comments. Otherwise good.

@openjdk
Copy link

@openjdk openjdk bot commented Feb 3, 2021

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

8252389: Fix mistakes in FX API docs

Reviewed-by: aghaisas, kcr

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 jfx16 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 jfx16 branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready label Feb 3, 2021
@nlisker
Copy link
Collaborator Author

@nlisker nlisker commented Feb 3, 2021

/integrate

@openjdk openjdk bot closed this Feb 3, 2021
@openjdk openjdk bot added integrated and removed ready rfr labels Feb 3, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Feb 3, 2021

@nlisker Pushed as commit 0f20a98.

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

@nlisker nlisker deleted the 8252389_Fix_mistakes_in_FX_API_docs branch Feb 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated
4 participants