Skip to content
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

8271268: Fix Javadoc links for Stream.mapMulti #15794

Closed
wants to merge 4 commits into from

Conversation

mabbay
Copy link
Member

@mabbay mabbay commented Sep 18, 2023

Fix Javadoc links for Stream.mapMulti, Stream.MapMultiInt, Stream.mapMultiToInt, Stream.mapMultiToLong and Stream.mapMultiToDouble.


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-8271268: Fix Javadoc links for Stream.mapMulti (Enhancement - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 15794

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

Using diff file

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

Webrev

Link to Webrev Comment

@bridgekeeper bridgekeeper bot added the oca Needs verification of OCA signatory status label Sep 18, 2023
@bridgekeeper
Copy link

bridgekeeper bot commented Sep 18, 2023

Hi @mabbay, welcome to this OpenJDK project and thanks for contributing!

We do not recognize you as Contributor and need to ensure you have signed the Oracle Contributor Agreement (OCA). If you have not signed the OCA, please follow the instructions. Please fill in your GitHub username in the "Username" field of the application. Once you have signed the OCA, please let us know by writing /signed in a comment in this pull request.

If you already are an OpenJDK Author, Committer or Reviewer, please click here to open a new issue so that we can record that fact. Please use "Add GitHub user mabbay" as summary for the issue.

If you are contributing this work on behalf of your employer and your employer has signed the OCA, please let us know by writing /covered in a comment in this pull request.

@openjdk
Copy link

openjdk bot commented Sep 18, 2023

@mabbay 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 core-libs-dev@openjdk.org label Sep 18, 2023
@mabbay mabbay changed the title Fix Javadoc links for Stream.mapMulti 8271268: Fix Javadoc links for Stream.mapMulti Sep 18, 2023
@PaulSandoz
Copy link
Member

PaulSandoz commented Sep 18, 2023

Note to others. I suggested @mabbay pick up the dropped PR, as a starter issue to help achieve OpenJDK author status.

@mabbay
Copy link
Member Author

mabbay commented Sep 20, 2023

/covered

@bridgekeeper bridgekeeper bot added the oca-verify Needs verification of OCA signatory status label Sep 20, 2023
@bridgekeeper
Copy link

bridgekeeper bot commented Sep 20, 2023

Thank you! Please allow for a few business days to verify that your employer has signed the OCA. Also, please note that pull requests that are pending an OCA check will not usually be evaluated, so your patience is appreciated!

@bridgekeeper bridgekeeper bot removed oca Needs verification of OCA signatory status oca-verify Needs verification of OCA signatory status labels Sep 20, 2023
@openjdk openjdk bot added the rfr Pull request is ready for review label Sep 20, 2023
@mlbridge
Copy link

mlbridge bot commented Sep 20, 2023

Webrevs

@liach
Copy link
Member

liach commented Sep 22, 2023

What is this patch looking to fix? The link is not broken in the first place. This #mapMulti mapMulti aims to hide the irrelevant long list of parameter types Javadoc renders, like that seen in flatMap's "See Also" section.

I believe a simple mapMulti is better than an overblown mapMulti(java.util.function.BiConsumer<? super T, ? super java.util.function.Consumer<R>>). However, it's always better to unify the rendering in both cases, such as updating the link in flatMap's @see to @see #mapMulti mapMulti.

@mabbay
Copy link
Member Author

mabbay commented Sep 22, 2023

@liach here the result of having @see #mapMulti mapMulti
Screenshot 2023-09-22 at 11 57 44 AM

@liach
Copy link
Member

liach commented Sep 22, 2023

Then it's a bug with Intellij IDEA not able to parse these links correctly. It should be fixed in their open source repository at https://github.com/JetBrains/intellij-community instead.

@mabbay
Copy link
Member Author

mabbay commented Sep 22, 2023

@liach I see, thanks for the review. Should I open a new PR to unify the rendering?

@liach
Copy link
Member

liach commented Sep 22, 2023

I recommend just work in the same PR and change all @see #mapMulti to @see #mapMulti mapMulti and @see #flatMap to @see #flatMap flatMap. This is how our current link conventions are like:

* {@link #addFirst addFirst} and {@link #addLast addLast} methods.

I've already updated the Java Bug System issue for you.

@openjdk
Copy link

openjdk bot commented Sep 22, 2023

⚠️ @mabbay the full name on your profile does not match the author name in this pull requests' HEAD commit. If this pull request gets integrated then the author name from this pull requests' HEAD commit will be used for the resulting commit. If you wish to push a new commit with a different author name, then please run the following commands in a local repository of your personal fork:

$ git checkout pr/8271268
$ git commit --author='Preferred Full Name <you@example.com>' --allow-empty -m 'Update full name'
$ git push

@openjdk
Copy link

openjdk bot commented Sep 22, 2023

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

8271268: Fix Javadoc links for Stream.mapMulti

Reviewed-by: liach, psandoz

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:

  • 68a9c81: 8316711: SEGV in LoaderConstraintTable::find_loader_constraint after JDK-8310874
  • e015e6c: 8315825: Open some swing tests
  • 9aaac2e: 8301639: JDI and JDWP specs should clarify potential deadlock issues with method invocation
  • 6b8261b: 8315464: Uncouple AllClassesIndexWriter from IndexBuilder
  • 9b65b7d: 8316305: Initial buffer size of StackWalker is too small caused by JDK-8285447
  • 53516ae: 8304956: Update KeyStore.getDefaultType​() specification to return pkcs12 as fallback
  • 373cdf2: 8315960: test/jdk/java/io/File/TempDirDoesNotExist.java leaves test files behind
  • f7578e8: 8316540: StoreReproducibilityTest fails on some locales
  • b66ded9: 8316688: Widen allowable error bound of Math.hypot
  • 6c61bc1: 8316514: Better diagnostic header for VtableStub
  • ... and 111 more: https://git.openjdk.org/jdk/compare/42dc6b5d3a620c208717d875eb4caa5dc74013f2...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 (@PaulSandoz) 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 Sep 22, 2023
@mabbay
Copy link
Member Author

mabbay commented Sep 22, 2023

/integrate

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

openjdk bot commented Sep 22, 2023

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

@PaulSandoz
Copy link
Member

/sponsor

@openjdk
Copy link

openjdk bot commented Sep 25, 2023

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

Your commit was automatically rebased without conflicts.

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

openjdk bot commented Sep 25, 2023

@PaulSandoz @mabbay Pushed as commit afa4833.

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

@mabbay mabbay deleted the pr/8271268 branch June 5, 2024 23:30
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 integrated Pull request has been integrated
3 participants