JDK-8296661 : Typo Found In CSSParser.java #10975

scientificware · 2022-11-04T01:56:05Z

This is referenced in Java Bug Database as

JDK-8296661 : Typo Found In CSSParser.java

This is tracked in JBS as

JDK-8296661 : Typo Found In CSSParser.java

I suspect a typo in the documentation comments.

Designed from : ScientificWare JDK-8296661 : Typo Found In CSSParser.java

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-8296661: Typo Found In CSSParser.java

Reviewers

Andy Goryachev (@andy-goryachev-oracle - no project role)
@SWinxy (no known github.com user name / role) ⚠️ Review applies to 4bfba96a
Alexey Ivanov (@aivanov-jdk - Reviewer)
Phil Race (@prrace - Reviewer) ⚠️ Review applies to 3a6eac4c

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 10975

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

Using diff file

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

I suspect a typo in the documentation comments.

bridgekeeper · 2022-11-04T01:57:17Z

👋 Welcome back scientificware! 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 · 2022-11-04T01:59:33Z

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

client

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 · 2022-11-09T15:42:12Z

Webrevs

aivanov-jdk

Looks good to me.

In the description above: “…invoked one per property…”, it shoud be “once”.

I think there's room for improvement. However, this is an internal-only class.

aivanov-jdk · 2022-12-05T18:56:40Z

src/java.desktop/share/classes/javax/swing/text/html/CSSParser.java

 * <p>
- * This will preserve case. If the callback wishes to treat certain poritions
+ * This will preserve case. If the callback wishes to treat certain portions
 * case insensitively (such as selectors), it should use toLowerCase, or


Should this be “case-insensitively” with the hyphen?

case-insensitively seems to be the most common usage in this repository.

aivanov-jdk · 2022-12-05T19:10:41Z

You have to update the subject of the PR to match the JBS title which was edited by someone to be more specific.

openjdk · 2022-12-06T18:10:44Z

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

8296661: Typo Found In CSSParser.java

Reviewed-by: angorya, aivanov, prr

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

ccf2f58: 8300806: Update googletest to v1.13.0
edf1e1a: 8300592: ASan build does not correctly propagate options to some test launchers
e80b5ea: 8299635: Hotspot update for deprecated sprintf in Xcode 14
f279c75: 8300805: Update autoconf build-aux files with latest from 2022-09-17
a23ff63: 8301086: jdk/internal/util/ByteArray/ReadWriteValues.java fails with CompilationError
61775c8: 8300997: Add curl support to createJMHBundle.sh
8a47429: 8295944: Move the Http2TestServer and related classes into a package of its own
c8ad600: 8301004: httpclient: Add more debug to HttpResponseInputStream
74e1a8b: 8300236: Use VarHandle access in Data(Input | Output)Stream classes
a5d8e12: 8300244: Replace NULL with nullptr in share/interpreter/
... and 1143 more: https://git.openjdk.org/jdk/compare/4d1bc1b5add61f443f99f6d0726ebf8e37dc14ab...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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@aivanov-jdk, @prrace) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

aivanov-jdk · 2022-12-06T18:29:11Z

/sponsor

openjdk · 2022-12-06T18:36:55Z

@aivanov-jdk The change author (@scientificware) must issue an integrate command before the integration can be sponsored.

scientificware · 2022-12-10T08:23:32Z

/integrate

openjdk · 2022-12-10T08:25:31Z

@scientificware
Your change (at version 9443d02) is now ready to be sponsored by a Committer.

Replace one by once.

Add hyphen to "case insensitively". "case-insensitively" seems to be the common usage in the jdk repository.

aivanov-jdk · 2022-12-12T13:06:09Z

I think there's room for improvement. However, this is an internal-only class.

This is what I have in mind. The list of callbacks is inconsistent in how the method and conditions when it's called are listed. One of the list items has no ending punctuation. Some portions of text should use <code> or {@code}, or even <samp>.

I think <p> should be added before this sentence, “If an error results in parsing, a RuntimeException will be thrown.” The sentence itself requires re-writing: “If parsing results in an error…”

Both RuntimeException and toLowerCase below should be in {@code}.

The usage of <code> could be updated to {@code} which is the recommended way.

What do you think?

scientificware · 2022-12-28T00:08:59Z

@aivanov-jdk Done.

bridgekeeper · 2023-01-25T01:39:39Z

@scientificware 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!

scientificware · 2023-01-25T01:57:11Z

Please, don't close this PR.

SWinxy · 2023-01-25T04:08:31Z

I think a Reviewer needs to re-review before it asks for sponsoring. @aivanov-jdk: re-approve changes?

src/java.desktop/share/classes/javax/swing/text/html/CSSParser.java

andy-goryachev-oracle · 2023-01-25T16:13:00Z

Pre-submit tests - linux-x86 / test - Test (tier1) Failing after 67m — 1/9 failed

do we know why this test is failing?

SWinxy · 2023-01-25T16:54:06Z

do we know why this test is failing?

Doesn't matter; it's javadoc changes only. Pre-submit tests randomly fail sometimes for no good reason.

prrace · 2023-01-25T18:33:29Z

I think a Reviewer needs to re-review before it asks for sponsoring. @aivanov-jdk: re-approve changes?

No .. I think that the person who owns the PR needs to re-do the /integrate and that is what will make the sponsor label re-appear.

The year in the copyright headers should be updated to 2023

scientificware · 2023-01-25T18:37:17Z

/integrate

openjdk · 2023-01-25T18:38:51Z

@scientificware
Your change (at version d11d715) is now ready to be sponsored by a Committer.

andy-goryachev-oracle

excellent

andy-goryachev-oracle · 2023-01-25T18:58:21Z

/sponsor

openjdk · 2023-01-25T18:59:25Z

@andy-goryachev-oracle Only Committers are allowed to sponsor changes.

aivanov-jdk · 2023-01-25T19:19:34Z

/sponsor

openjdk · 2023-01-25T19:20:48Z

Going to push as commit 9f0887e.
Since your change was applied there have been 1153 commits pushed to the master branch:

ccf2f58: 8300806: Update googletest to v1.13.0
edf1e1a: 8300592: ASan build does not correctly propagate options to some test launchers
e80b5ea: 8299635: Hotspot update for deprecated sprintf in Xcode 14
f279c75: 8300805: Update autoconf build-aux files with latest from 2022-09-17
a23ff63: 8301086: jdk/internal/util/ByteArray/ReadWriteValues.java fails with CompilationError
61775c8: 8300997: Add curl support to createJMHBundle.sh
8a47429: 8295944: Move the Http2TestServer and related classes into a package of its own
c8ad600: 8301004: httpclient: Add more debug to HttpResponseInputStream
74e1a8b: 8300236: Use VarHandle access in Data(Input | Output)Stream classes
a5d8e12: 8300244: Replace NULL with nullptr in share/interpreter/
... and 1143 more: https://git.openjdk.org/jdk/compare/4d1bc1b5add61f443f99f6d0726ebf8e37dc14ab...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-01-25T19:21:07Z

@aivanov-jdk @scientificware Pushed as commit 9f0887e.

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

aivanov-jdk · 2023-01-25T19:29:32Z

@aivanov-jdk Done.

Sorry, @scientificware, I missed the update.

After making changes, you have to issue integrate command again.

In fact, I didn't mean to include the changes I suggested in this PR.

I still think there's room for improvement, however, it's not visible publicly. The list is inconsistent:

“The delegate is notified of the following events:” — one would expect a list of events. Instead, each list item starts differently. If I may suggest, starting each item with a callback method followed by the condition when it's called and additional details will present a more consistent documentation. The introduction sentence before the list may also be updated.

scientificware · 2023-01-25T20:24:11Z

@aivanov-jdk Thanks.

Fix typos in CSSParser.java

9443d02

I suspect a typo in the documentation comments.

scientificware changed the title ~~Fix typos in CSSParser.java~~ Fix typo in CSSParser.java Nov 4, 2022

openjdk bot added the client [email protected] label Nov 4, 2022

scientificware changed the title ~~Fix typo in CSSParser.java~~ JDK-8296661 : Fix typo Nov 9, 2022

openjdk bot added the rfr Pull request is ready for review label Nov 9, 2022

andy-goryachev-oracle approved these changes Nov 9, 2022

View reviewed changes

SWinxy approved these changes Nov 20, 2022

View reviewed changes

aivanov-jdk approved these changes Dec 5, 2022

View reviewed changes

scientificware changed the title ~~JDK-8296661 : Fix typo~~ JDK-8296661 : Typo Found In CSSParser.java Dec 6, 2022

openjdk bot added the ready Pull request is ready to be integrated label Dec 6, 2022

openjdk bot added the sponsor Pull request is ready to be sponsored label Dec 10, 2022

Another type.

4bfba96

Replace one by once.

openjdk bot removed the sponsor Pull request is ready to be sponsored label Dec 10, 2022

SWinxy approved these changes Dec 11, 2022

View reviewed changes

Another typo

8b5eab5

Add hyphen to "case insensitively". "case-insensitively" seems to be the common usage in the jdk repository.

aivanov-jdk approved these changes Dec 12, 2022

View reviewed changes

andy-goryachev-oracle reviewed Jan 25, 2023

View reviewed changes

src/java.desktop/share/classes/javax/swing/text/html/CSSParser.java Outdated Show resolved Hide resolved

prrace approved these changes Jan 25, 2023

View reviewed changes

Update copyright year

d11d715

The year in the copyright headers should be updated to 2023

openjdk bot added the sponsor Pull request is ready to be sponsored label Jan 25, 2023

andy-goryachev-oracle approved these changes Jan 25, 2023

View reviewed changes

aivanov-jdk approved these changes Jan 25, 2023

View reviewed changes

openjdk bot removed the ready Pull request is ready to be integrated label Jan 25, 2023

openjdk bot added the ready Pull request is ready to be integrated label Jan 25, 2023

openjdk bot added the integrated Pull request has been integrated label Jan 25, 2023

openjdk bot closed this Jan 25, 2023

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review sponsor Pull request is ready to be sponsored labels Jan 25, 2023

scientificware mentioned this pull request Aug 12, 2022

JDK-8265909 : build.tools.dtdbuilder.DTDBuilder.java failed detecting missing path of dtd_home #3626 scientificware/jdk#2

Open

JDK-8296661 : Typo Found In CSSParser.java #10975

JDK-8296661 : Typo Found In CSSParser.java #10975

Uh oh!

Conversation

scientificware commented Nov 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Nov 4, 2022

Uh oh!

openjdk bot commented Nov 4, 2022

Uh oh!

mlbridge bot commented Nov 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

aivanov-jdk left a comment

Choose a reason for hiding this comment

Uh oh!

aivanov-jdk Dec 5, 2022

Choose a reason for hiding this comment

Uh oh!

scientificware Dec 12, 2022

Choose a reason for hiding this comment

Uh oh!

aivanov-jdk commented Dec 5, 2022

Uh oh!

openjdk bot commented Dec 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aivanov-jdk commented Dec 6, 2022

Uh oh!

openjdk bot commented Dec 6, 2022

Uh oh!

scientificware commented Dec 10, 2022

Uh oh!

openjdk bot commented Dec 10, 2022

Uh oh!

aivanov-jdk commented Dec 12, 2022

Uh oh!

scientificware commented Dec 28, 2022

Uh oh!

bridgekeeper bot commented Jan 25, 2023

Uh oh!

scientificware commented Jan 25, 2023

Uh oh!

SWinxy commented Jan 25, 2023

Uh oh!

Uh oh!

andy-goryachev-oracle commented Jan 25, 2023

Uh oh!

SWinxy commented Jan 25, 2023

Uh oh!

prrace commented Jan 25, 2023

Uh oh!

scientificware commented Jan 25, 2023

Uh oh!

openjdk bot commented Jan 25, 2023

Uh oh!

andy-goryachev-oracle left a comment

Choose a reason for hiding this comment

Uh oh!

andy-goryachev-oracle commented Jan 25, 2023

Uh oh!

openjdk bot commented Jan 25, 2023

Uh oh!

aivanov-jdk commented Jan 25, 2023

Uh oh!

openjdk bot commented Jan 25, 2023

Uh oh!

openjdk bot commented Jan 25, 2023

Uh oh!

aivanov-jdk commented Jan 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

scientificware commented Jan 25, 2023

Uh oh!

scientificware commented Nov 4, 2022 •

edited

Loading

mlbridge bot commented Nov 9, 2022 •

edited

Loading

openjdk bot commented Dec 6, 2022 •

edited

Loading

aivanov-jdk commented Jan 25, 2023 •

edited

Loading