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.

Sign up for GitHub

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

Jump to bottom

JDK-8303123: Add line break opportunity to single type parameters #13119

Closed
wants to merge 1 commit into from
Closed

JDK-8303123: Add line break opportunity to single type parameters #13119

wants to merge 1 commit into from
+53 −28

Conversation

hns
Copy link
Member

@hns hns commented Mar 21, 2023 •
edited by openjdk bot
Loading

Please review a simple change to add a <wbr> (line break opportunity) tag before type parameters in some type links. This is only used in the first column of member summary tables as this is the only place where we have type names with full type parameters and no natural line break opportunities in a very limited horizontal space. Attached below is a screenshot of the method summary table of java.net.http.HttpResponse.BodySubscribers with this fix applied (see JBS issue for a screenshot of the previous rendering).

return-type-line-breaks

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-8303123: Add line break opportunity to single type parameters

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 13119

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

Using diff file

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

Sorry, something went wrong.

@hns
JDK-8303123: Add line break opportunity to single type parameters

Verified

This commit was signed with the committer’s verified signature.
sergeyklay Serghei Iakovlev
GPG key ID: C6AF1016BBDEA800
Verified
Learn about vigilant mode
39834e4
@bridgekeeper
Copy link

bridgekeeper bot commented Mar 21, 2023

👋 Welcome back hannesw! 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 Mar 21, 2023
@openjdk
Copy link

openjdk bot commented Mar 21, 2023

@hns The following label will be automatically applied to this pull request:

  • javadoc

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 javadoc javadoc-dev@openjdk.org label Mar 21, 2023
@mlbridge
Copy link

mlbridge bot commented Mar 21, 2023

Webrevs

jonathan-gibbons
jonathan-gibbons reviewed Mar 31, 2023
View reviewed changes
...dk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractMemberWriter.java
//Code to avoid ugly wrapping in member summary table.
code.add(typeParameters);
// Add explicit line break between method type parameters and
// return type in member summary table to avoid random wrapping.
if (typeParameters.charCount() > 10) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to this PR, I still dislike these unnamed numeric values.

jonathan-gibbons
jonathan-gibbons approved these changes Mar 31, 2023
View reviewed changes
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks. good to me.

@openjdk
Copy link

openjdk bot commented Mar 31, 2023

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

8303123: Add line break opportunity to single type parameters

Reviewed-by: jjg

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

  • abfb900: 8304028: Port fdlibm IEEEremainder to Java
  • a565be4: 8297605: improve DelayQueue removal method javadoc
  • cccb019: 8304928: Optimize ClassDesc.resolveConstantDesc
  • bdbf8fc: 8303930: Fix ConstantUtils.skipOverFieldSignature void case return value
  • 4a5d7ca: 8305227: [s390x] build broken after JDK-8231349
  • dae1ab3: 8304844: JFR: Missing disk parameter in ActiveRecording event
  • e012685: 8305066: [JVMCI] guarantee(ik->is_initialized()) failed: java/lang/Long$LongCache must be initialized
  • fe42312: 8304820: Statically allocate ObjectSynchronizer mutexes
  • 2f36eb0: 8305323: Update java/net/httpclient/ContentLengthHeaderTest.java to use new HttpTestServer factory methods
  • 049b953: 8305223: IGV: mark osr compiled graphs with [OSR] in the name
  • ... and 129 more: https://git.openjdk.org/jdk/compare/1c04686cd68a78f926f09707ac723aa762945527...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.

➡️ 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 Pull request is ready to be integrated label Mar 31, 2023
@hns
Copy link
Member Author

hns commented Apr 3, 2023

/integrate

@openjdk
Copy link

openjdk bot commented Apr 3, 2023

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

  • 094e03d: 8299718: JavaDoc: Buttons to copy specific documentation URL are not accessible
  • 4de24cd: 8303210: [linux, Windows] Make UseSystemMemoryBarrier available as product flag
  • 336a23e: 8303229: JFR: Preserve disk repository after exit
  • ecec611: 8283404: [macos] a11y : Screen magnifier does not show JMenu name
  • aa76210: 8304893: Link Time Optimization with gcc can be faster
  • b8c748d: 8294266: Add a way to pre-touch java thread stacks
  • 41a3db2: 8304815: Use NMT for more precise hs_err location printing
  • 34e66ce: 8304295: harfbuzz build fails with GCC 7 after JDK-8301998
  • a19b28a: 8297539: Use PrimitiveConversions::cast for local uses of the int<->float union conversion trick
  • 8eb4e7e: 8277501: Revisit PathFileObject.getCharContent and friends
  • ... and 139 more: https://git.openjdk.org/jdk/compare/1c04686cd68a78f926f09707ac723aa762945527...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Apr 3, 2023
@openjdk openjdk bot closed this Apr 3, 2023
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Apr 3, 2023
@openjdk
Copy link

openjdk bot commented Apr 3, 2023

@hns Pushed as commit 2e91585.

💡 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
Reviewers

@jonathan-gibbons jonathan-gibbons

Assignees
No one assigned
Labels
integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@hns @jonathan-gibbons