8300011: Refactor code examples to use @snippet in java.util.TimeZone #11955

justin-curtis-lu · 2023-01-11T23:41:46Z

This PR implements JEP 413: Code Snippets in Java API Documentation for java.util.TimeZone.

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

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-8300011: Refactor code examples to use @snippet in java.util.TimeZone

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 11955

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

Using diff file

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

bridgekeeper · 2023-01-11T23:42:57Z

👋 Welcome back justin-curtis-lu! 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-11T23:45:56Z

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

core-libs

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 · 2023-01-12T19:20:56Z

Webrevs

naotoj · 2023-01-12T21:08:12Z

src/java.base/share/classes/java/util/TimeZone.java

-     *                Locale.getDefault({@link Locale.Category#DISPLAY}))
-     * </pre></blockquote>
+     * {@snippet lang=java :
+     * getDisplayName(false, LONG, // @link substring="LONG" target="#LONG"


You could move those @link directives above the code and concatenate them with ":", e.g,

* // @link substring="LONG" target="#LONG" : * getDisplayName(false, LONG,

so that the line won't be very long.

Did not realize that could be done, made the fix, thank you

justin-curtis-lu · 2023-01-12T21:47:26Z

src/java.base/share/classes/java/util/TimeZone.java

@@ -63,9 +63,9 @@
 * along with a time zone ID. For instance, the time zone ID for the
 * U.S. Pacific Time zone is "America/Los_Angeles". So, you can get a
 * U.S. Pacific Time {@code TimeZone} object with:
- * <blockquote><pre>


@naotoj <blockquote> actually adds indentation for the contents contained within. So I will be reverting the removal of those tags to prevent visual change.

openjdk · 2023-01-13T04:10:16Z

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

8300011: Refactor code examples to use @snippet in java.util.TimeZone

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

8c12ae8: 8283203: Fix typo in SystemTray.getTrayIconSize javadoc
e7e3712: 8300010: UnsatisfiedLinkError on calling System.console().readPassword() on Windows
0b9ff06: 8300184: Optimize ResourceHashtableBase::iterate_all using _number_of_entries
75b122f: 8300120: Configure should support different defaults for CI/dev build environments
e139ec3: 8300069: Left shift of negative value in share/adlc/dict2.cpp
fb147aa: 8300228: ModuleReader.find on exploded module throws if resource name maps to invalid file path
4cd166f: 8300125: Serial: Remove unused Generation::reset_saved_marks
85d70ac: Merge
e15bdc5: 8299789: Compilation of gtest causes build to fail if runtime libraries are in different dirs
b7fb8ef: 8299323: Allow extended registers for cmpw
... and 111 more: https://git.openjdk.org/jdk/compare/f79b3d42f07b703f0e3b9fc67c92dee260b0e602...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).

LanceAndersen · 2023-01-13T11:07:07Z

src/java.base/share/classes/java/util/TimeZone.java

+     * // @link substring="LONG" target="#LONG" :
+     * getDisplayName(false, LONG,
+     *                // @link substring="Locale.Category.DISPLAY" target="Locale.Category#DISPLAY" :
+     *                Locale.getDefault(Locale.Category.DISPLAY))


One thought here as I look at this again and now that this is a snippet is that we should probably add the trailing ; to the code examples...

justin-curtis-lu · 2023-01-17T18:12:14Z

/integrate

openjdk · 2023-01-17T18:16:13Z

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

naotoj · 2023-01-17T18:28:51Z

/sponsor

openjdk · 2023-01-17T18:30:41Z

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

8c12ae8: 8283203: Fix typo in SystemTray.getTrayIconSize javadoc
e7e3712: 8300010: UnsatisfiedLinkError on calling System.console().readPassword() on Windows
0b9ff06: 8300184: Optimize ResourceHashtableBase::iterate_all using _number_of_entries
75b122f: 8300120: Configure should support different defaults for CI/dev build environments
e139ec3: 8300069: Left shift of negative value in share/adlc/dict2.cpp
fb147aa: 8300228: ModuleReader.find on exploded module throws if resource name maps to invalid file path
4cd166f: 8300125: Serial: Remove unused Generation::reset_saved_marks
85d70ac: Merge
e15bdc5: 8299789: Compilation of gtest causes build to fail if runtime libraries are in different dirs
b7fb8ef: 8299323: Allow extended registers for cmpw
... and 111 more: https://git.openjdk.org/jdk/compare/f79b3d42f07b703f0e3b9fc67c92dee260b0e602...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-01-17T18:31:07Z

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

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

Replace <pre> blocks with @snippet

dae09b0

justin-curtis-lu changed the title ~~Replace <pre> blocks with @snippet~~ 8300011: Refactor code examples to use @snippet in java.util.TimeZone Jan 11, 2023

openjdk bot added the core-libs core-libs-dev@openjdk.org label Jan 11, 2023

justin-curtis-lu marked this pull request as ready for review January 12, 2023 19:15

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

naotoj reviewed Jan 12, 2023

View reviewed changes

Move link to separate lines

70d8fa8

justin-curtis-lu commented Jan 12, 2023

View reviewed changes

Re-add blockquotes (indendation)

a2f5789

LanceAndersen approved these changes Jan 12, 2023

View reviewed changes

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

LanceAndersen reviewed Jan 13, 2023

View reviewed changes

Add trailing ; to code examples

1e9fee1

naotoj approved these changes Jan 13, 2023

View reviewed changes

LanceAndersen approved these changes Jan 13, 2023

View reviewed changes

irisclark approved these changes Jan 13, 2023

View reviewed changes

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

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

openjdk bot closed this Jan 17, 2023

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

openjdk bot removed the sponsor Pull request is ready to be sponsored label Jan 17, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

8300011: Refactor code examples to use @snippet in java.util.TimeZone #11955

8300011: Refactor code examples to use @snippet in java.util.TimeZone #11955

Uh oh!

justin-curtis-lu commented Jan 11, 2023 •

edited by openjdk bot

Loading

Uh oh!

bridgekeeper bot commented Jan 11, 2023

Uh oh!

openjdk bot commented Jan 11, 2023

Uh oh!

mlbridge bot commented Jan 12, 2023 •

edited

Loading

Uh oh!

naotoj Jan 12, 2023

Uh oh!

justin-curtis-lu Jan 12, 2023

Uh oh!

justin-curtis-lu Jan 12, 2023

Uh oh!

openjdk bot commented Jan 13, 2023 •

edited

Loading

Uh oh!

LanceAndersen Jan 13, 2023

Uh oh!

justin-curtis-lu commented Jan 17, 2023

Uh oh!

openjdk bot commented Jan 17, 2023

Uh oh!

naotoj commented Jan 17, 2023

Uh oh!

openjdk bot commented Jan 17, 2023

Uh oh!

openjdk bot commented Jan 17, 2023

Uh oh!

Uh oh!

8300011: Refactor code examples to use @snippet in java.util.TimeZone #11955

8300011: Refactor code examples to use @snippet in java.util.TimeZone #11955

Uh oh!

Conversation

justin-curtis-lu commented Jan 11, 2023 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Jan 11, 2023

Uh oh!

openjdk bot commented Jan 11, 2023

Uh oh!

mlbridge bot commented Jan 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

naotoj Jan 12, 2023

Choose a reason for hiding this comment

Uh oh!

justin-curtis-lu Jan 12, 2023

Choose a reason for hiding this comment

Uh oh!

justin-curtis-lu Jan 12, 2023

Choose a reason for hiding this comment

Uh oh!

openjdk bot commented Jan 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LanceAndersen Jan 13, 2023

Choose a reason for hiding this comment

Uh oh!

justin-curtis-lu commented Jan 17, 2023

Uh oh!

openjdk bot commented Jan 17, 2023

Uh oh!

naotoj commented Jan 17, 2023

Uh oh!

openjdk bot commented Jan 17, 2023

Uh oh!

openjdk bot commented Jan 17, 2023

Uh oh!

Uh oh!

justin-curtis-lu commented Jan 11, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Jan 12, 2023 •

edited

Loading

openjdk bot commented Jan 13, 2023 •

edited

Loading