8300589: Use @snippet and @linkplain in java.text.CollationKey and java.text.CompactNumberFormat #12108

justin-curtis-lu · 2023-01-19T22:25:51Z

This PR implements JEP 413: Code Snippets in Java API Documentation for java.text.CollationKey and java.text.CompactNumberFormat.

Code examples using <pre> ... </pre> blocks are replaced with the @ snippet syntax where applicable.

Additionally, for java.text.CompactNumberFormat internal plain text links using <a> ... </a> are replaced with @ linkplain. (External links are kept the same)

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-8300589: Use @snippet and @linkplain in java.text.CollationKey and java.text.CompactNumberFormat

Reviewers

Lance Andersen (@LanceAndersen - Reviewer)
Naoto Sato (@naotoj - Reviewer)
Iris Clark (@irisclark - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 12108

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

Using diff file

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

bridgekeeper · 2023-01-19T22:27:32Z

👋 Welcome back jlu! 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 · 2023-01-19T22:30:24Z

@justin-curtis-lu The following labels will be automatically applied to this pull request:

core-libs
i18n

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

mlbridge · 2023-01-19T22:34:01Z

Webrevs

01: Full - Incremental (0bd91514)
00: Full (889f582c)

openjdk · 2023-01-19T22:52:50Z

@justin-curtis-lu 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:

8300589: Use @snippet and @linkplain in java.text.CollationKey and java.text.CompactNumberFormat

Reviewed-by: lancea, naoto, iris

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

77a5010: 8286775: Remove identical per-compiler definitions of unsigned integral jtypes
f79e587: 8300828: Avoid unnecessary array fill after creation in com.sun.media.sound
56dc3b0: Merge
fd75217: 8290919: Update nroff pages in JDK 20 before RC
0ea2dd1: 8146132: Excessive output from make test-image
dcf1523: 8300077: Refactor code examples to use @snippet in java.text.ChoiceFormat
d117350: 8300866: Declare some classes final in java.io
1a3cb8c: 8296343: CPVE thrown on missing content-length in OCSP response
86fed79: 8300693: Lower the compile threshold and reduce the iterations of warmup loop in VarHandles tests
4525aa3: 8300867: Fix document issues in java.io
... and 83 more: https://git.openjdk.org/jdk/compare/601e0ae7da472acb68b53f766b30a688e6bacbcf...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 (@LanceAndersen, @naotoj, @irisclark) 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).

naotoj

Looks good. Minor suggestions follow.

naotoj · 2023-01-19T23:20:52Z

src/java.base/share/classes/java/text/CompactNumberFormat.java

@@ -384,8 +384,8 @@ public final class CompactNumberFormat extends NumberFormat {
     * @param decimalPattern a decimal pattern for general number formatting
     * @param symbols the set of symbols to be used
     * @param compactPatterns an array of
-     *        <a href = "CompactNumberFormat.html#compact_number_patterns">
-     *        compact number patterns</a>
+     *        {@linkplain CompactNumberFormat##compact_number_patterns


Can eliminate CompactNumberFormat here.

Ah good point, it's the same file. Will make the change, thanks!

naotoj · 2023-01-19T23:21:09Z

src/java.base/share/classes/java/text/CompactNumberFormat.java

@@ -412,8 +412,8 @@ public CompactNumberFormat(String decimalPattern,
     * @param decimalPattern a decimal pattern for general number formatting
     * @param symbols the set of symbols to be used
     * @param compactPatterns an array of
-     *        <a href = "CompactNumberFormat.html#compact_number_patterns">
-     *        compact number patterns</a>
+     *        {@linkplain CompactNumberFormat##compact_number_patterns


Same as above.

justin-curtis-lu · 2023-01-24T01:01:43Z

/integrate

openjdk · 2023-01-24T01:02:52Z

@justin-curtis-lu
Your change (at version 0bd9151) is now ready to be sponsored by a Committer.

naotoj · 2023-01-24T02:02:38Z

/sponosr

openjdk · 2023-01-24T02:03:24Z

@naotoj Unknown command sponosr - for a list of valid commands use /help.

naotoj · 2023-01-24T04:34:52Z

/sponsor

openjdk · 2023-01-24T04:35:53Z

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

afd5921: 8298610: Refactor archiving of ConstantPool::resolved_references()
937ba1c: 8300111: Add rpath for common lib locations for jpackageapplauncher
2da2e5a: 8300946: Add sun/security/provider/certpath/OCSP/OCSPNoContentLength to ProblemList
0323609: 8300706: Use @snippet in java.text
b5ee3d1: 8299497: Usage of constructors of primitive wrapper classes should be avoided in java.desktop API docs
77a5010: 8286775: Remove identical per-compiler definitions of unsigned integral jtypes
f79e587: 8300828: Avoid unnecessary array fill after creation in com.sun.media.sound
56dc3b0: Merge
fd75217: 8290919: Update nroff pages in JDK 20 before RC
0ea2dd1: 8146132: Excessive output from make test-image
... and 88 more: https://git.openjdk.org/jdk/compare/601e0ae7da472acb68b53f766b30a688e6bacbcf...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-01-24T04:36:04Z

@naotoj @justin-curtis-lu Pushed as commit b3822f5.

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

justin-curtis-lu added 2 commits January 18, 2023 15:43

Swap to snippet

718f23f

Use linkplain for plain text internal links

889f582

openjdk bot added the rfr Pull request is ready for review label Jan 19, 2023

openjdk bot added core-libs core-libs-dev@openjdk.org i18n i18n-dev@openjdk.org labels Jan 19, 2023

LanceAndersen approved these changes Jan 19, 2023

View reviewed changes

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

naotoj reviewed Jan 19, 2023

View reviewed changes

Class can be removed for CNPatterns link

0bd9151

naotoj approved these changes Jan 20, 2023

View reviewed changes

LanceAndersen approved these changes Jan 20, 2023

View reviewed changes

irisclark approved these changes Jan 20, 2023

View reviewed changes

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

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

openjdk bot closed this Jan 24, 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 24, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8300589: Use @snippet and @linkplain in java.text.CollationKey and java.text.CompactNumberFormat #12108

8300589: Use @snippet and @linkplain in java.text.CollationKey and java.text.CompactNumberFormat #12108

justin-curtis-lu commented Jan 19, 2023 •

edited by openjdk bot

Loading

bridgekeeper bot commented Jan 19, 2023

openjdk bot commented Jan 19, 2023

mlbridge bot commented Jan 19, 2023 •

edited

Loading

openjdk bot commented Jan 19, 2023 •

edited

Loading

naotoj left a comment

naotoj Jan 19, 2023

justin-curtis-lu Jan 19, 2023

naotoj Jan 19, 2023

justin-curtis-lu commented Jan 24, 2023

openjdk bot commented Jan 24, 2023

naotoj commented Jan 24, 2023

openjdk bot commented Jan 24, 2023

naotoj commented Jan 24, 2023

openjdk bot commented Jan 24, 2023

openjdk bot commented Jan 24, 2023

8300589: Use @snippet and @linkplain in java.text.CollationKey and java.text.CompactNumberFormat #12108

8300589: Use @snippet and @linkplain in java.text.CollationKey and java.text.CompactNumberFormat #12108

Conversation

justin-curtis-lu commented Jan 19, 2023 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

bridgekeeper bot commented Jan 19, 2023

openjdk bot commented Jan 19, 2023

mlbridge bot commented Jan 19, 2023 • edited Loading

Webrevs

openjdk bot commented Jan 19, 2023 • edited Loading

naotoj left a comment

Choose a reason for hiding this comment

naotoj Jan 19, 2023

Choose a reason for hiding this comment

justin-curtis-lu Jan 19, 2023

Choose a reason for hiding this comment

naotoj Jan 19, 2023

Choose a reason for hiding this comment

justin-curtis-lu commented Jan 24, 2023

openjdk bot commented Jan 24, 2023

naotoj commented Jan 24, 2023

openjdk bot commented Jan 24, 2023

naotoj commented Jan 24, 2023

openjdk bot commented Jan 24, 2023

openjdk bot commented Jan 24, 2023

justin-curtis-lu commented Jan 19, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Jan 19, 2023 •

edited

Loading

openjdk bot commented Jan 19, 2023 •

edited

Loading