Skip to content
This repository has been archived by the owner. It is now read-only.

8268736: Use apiNote in AutoCloseable.close javadoc #63

Closed
wants to merge 1 commit into from
Closed

8268736: Use apiNote in AutoCloseable.close javadoc #63

wants to merge 1 commit into from

Conversation

jddarcy
Copy link
Member

@jddarcy jddarcy commented Jun 15, 2021

The javadoc of AutoCloseable.close is from JDK 7 and thus predates tags like @APinote. However, some of the discussion contained in AutoCloseable.close is more appropriate as an apiNote that normal text.


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

  • JDK-8268736: Use apiNote in AutoCloseable.close javadoc

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk17 pull/63/head:pull/63
$ git checkout pull/63

Update a local copy of the PR:
$ git checkout pull/63
$ git pull https://git.openjdk.java.net/jdk17 pull/63/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 63

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk17/pull/63.diff

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Jun 15, 2021

👋 Welcome back darcy! 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 label Jun 15, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Jun 15, 2021

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

@openjdk openjdk bot added the core-libs label Jun 15, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Jun 15, 2021

Webrevs

bplb
bplb approved these changes Jun 15, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Jun 15, 2021

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

8268736: Use apiNote in AutoCloseable.close javadoc

Reviewed-by: bpb, 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 no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ 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 label Jun 15, 2021
naotoj
naotoj approved these changes Jun 15, 2021
@pavelrappo
Copy link
Member

@pavelrappo pavelrappo commented Jun 15, 2021

I'm confused: I thought that both https://openjdk.java.net/jeps/8068562 and the actual usages of @apiNote in java.base accumulated since then are advisory to the API users rather than to API implementors.

@jddarcy
Copy link
Member Author

@jddarcy jddarcy commented Jun 15, 2021

/integrate

@openjdk
Copy link

@openjdk openjdk bot commented Jun 15, 2021

Going to push as commit 31a055e.

@openjdk openjdk bot closed this Jun 15, 2021
@openjdk openjdk bot added integrated and removed ready rfr labels Jun 15, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Jun 15, 2021

@jddarcy Pushed as commit 31a055e.

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
core-libs integrated
4 participants