Skip to content

Conversation

@nlisker
Copy link
Collaborator

@nlisker nlisker commented Aug 31, 2020

Correction to the order of transforms specified in the docs of Node.


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/293/head:pull/293
$ git checkout pull/293

@bridgekeeper
Copy link

bridgekeeper bot commented Aug 31, 2020

👋 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.

@nlisker nlisker marked this pull request as ready for review August 31, 2020 23:34
@openjdk openjdk bot added the rfr Ready for review label Aug 31, 2020
@mlbridge
Copy link

mlbridge bot commented Aug 31, 2020

Webrevs

@kevinrushforth
Copy link
Member

/reviewers 2

@openjdk
Copy link

openjdk bot commented Aug 31, 2020

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

Copy link
Member

@kevinrushforth kevinrushforth left a comment

Choose a reason for hiding this comment

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

The updated text look good, although there is a javadoc error that causes the build to fail. I left a few comments below.

* @return the boundsInParent for this {@code Node}
*
* @return the {@code boundsInParent} property for this {@code Node}
* @see {@linkplain Node Bounding Rectangles} section in the class docs
Copy link
Member

Choose a reason for hiding this comment

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

This causes a javadoc error:

> Task :javadoc
modules\javafx.graphics\src\main\java\javafx\scene\Node.java:3423: error: unexpected content
     * @see {@linkplain Node Bounding Rectangles} section in the class docs
       ^
1 error

> Task :javadoc FAILED

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@see doesn't show for properties because of the special handling (same goes for @return). I opted to create HTML links to the headers instead. I did it to all for them even if they are not all used.

Copy link
Member

@kevinrushforth kevinrushforth left a comment

Choose a reason for hiding this comment

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

Changes look good to me. I asked one question about whether you wanted to add another hyperlink, but it's up to you.

* </ol>
* The transforms are applied in the reverse order of the matrix multiplication outlined above: last element of the transforms list
* to 0th element, scale, rotate, and layout and translate. By applying the transforms in this order, the bounds in the local
* coordinates of the node are transformed to the bounds in the parent coordinate of the node (see the <b>Bounding Rectangles</b>
Copy link
Member

Choose a reason for hiding this comment

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

Maybe hyperlink to the Bounding Rectangles section? (although as it is right below, it isn't as important).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Originally I had "see the next section" but didn't want to depend on the order. I put the link anyway.

Copy link
Member

@arapte arapte left a comment

Choose a reason for hiding this comment

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

change looks good to me, javadoc built with no problem.

@openjdk
Copy link

openjdk bot commented Sep 14, 2020

@nlisker This change now passes all automated pre-integration checks. In addition to the automated checks, the change must also fulfill all project specific requirements

After integration, the commit message will be:

8252547: Correct transformations docs in Node

Reviewed-by: kcr, arapte
  • If you would like to add a summary, use the /summary command.
  • To credit additional contributors, use the /contributor command.
  • To add additional solved issues, use the /issue command.

Since the source branch of this PR was last updated there have been 6 commits pushed to 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 automatic rebasing, please merge master into your branch, and then specify the current head hash when integrating, like this: /integrate 0514116f27aa32c887e0bf718975f9a0a7d03fcd.

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

@openjdk openjdk bot added the ready Ready to be integrated label Sep 14, 2020
@nlisker
Copy link
Collaborator Author

nlisker commented Sep 14, 2020

/integrate

@openjdk openjdk bot closed this Sep 14, 2020
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Ready to be integrated labels Sep 14, 2020
@openjdk
Copy link

openjdk bot commented Sep 14, 2020

@nlisker Since your change was applied there have been 6 commits pushed to the master branch:

Your commit was automatically rebased without conflicts.

Pushed as commit d6dee34.

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

@openjdk openjdk bot removed the rfr Ready for review label Sep 14, 2020
@nlisker nlisker deleted the 8252547_Correct_transformations_docs_in_Node branch September 16, 2020 10:43
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.

3 participants