Skip to content

8300077: Refactor code examples to use @snippet in java.text.ChoiceFormat #11981

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

Conversation

justin-curtis-lu
Copy link
Member

@justin-curtis-lu justin-curtis-lu commented Jan 12, 2023

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

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

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 11981

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

Using diff file

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

@bridgekeeper
Copy link

bridgekeeper bot commented Jan 12, 2023

👋 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 openjdk bot added the rfr Pull request is ready for review label Jan 12, 2023
@openjdk
Copy link

openjdk bot commented Jan 12, 2023

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

@openjdk openjdk bot added core-libs core-libs-dev@openjdk.org i18n i18n-dev@openjdk.org labels Jan 12, 2023
@mlbridge
Copy link

mlbridge bot commented Jan 13, 2023

Webrevs

@openjdk
Copy link

openjdk bot commented Jan 13, 2023

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

8300077: Refactor code examples to use @snippet in java.text.ChoiceFormat

Reviewed-by: lancea, iris, naoto

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, @irisclark, @naotoj) 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).

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Jan 13, 2023
@justin-curtis-lu
Copy link
Member Author

/integrate

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

openjdk bot commented Jan 17, 2023

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

@naotoj
Copy link
Member

naotoj commented Jan 23, 2023

/sponsor

@openjdk
Copy link

openjdk bot commented Jan 23, 2023

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

  • 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
  • a7f035d: 8300868: Reduce visibility in java.io.SerialCallbackContext
  • 079255e: 8300864: Declare some fields in java.io as final
  • a56598f: 8299684: (bf) JNI direct buffer functions with large capacity behave unexpectedly
  • 542bfe6: 8300587: (bf) Some covariant overrides are missing @SInCE tags
  • 03a9a88: 8300265: Remove metaprogramming/isSigned.hpp
  • 5a4945c: 8299975: Limit underflow protection CMoveINode in PhaseIdealLoop::do_unroll must also protect type from underflow
  • ... and 229 more: https://git.openjdk.org/jdk/compare/f79b3d42f07b703f0e3b9fc67c92dee260b0e602...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Jan 23, 2023
@openjdk openjdk bot closed this Jan 23, 2023
@openjdk 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 23, 2023
@openjdk
Copy link

openjdk bot commented Jan 23, 2023

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-libs core-libs-dev@openjdk.org i18n i18n-dev@openjdk.org integrated Pull request has been integrated
Development

Successfully merging this pull request may close these issues.

4 participants