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

Enable hyperlinking to Java docs #8284

Merged
merged 1 commit into from Aug 30, 2019
Merged

Enable hyperlinking to Java docs #8284

merged 1 commit into from Aug 30, 2019

Conversation

ashawley
Copy link
Member

  • Add Java 8 entry to apiMappings of sbt build.
  • Fix a few ambiguous references.
Could not find any member to link for "ArithmeticException".
Could not find any member to link for "java.lang.Throwable#printStackTrace".
Could not find any member to link for "java.lang.Float.compare()".

Fixes scala/bug#11655.

@scala-jenkins scala-jenkins added this to the 2.13.1 milestone Jul 30, 2019
@ashawley ashawley mentioned this pull request Jul 30, 2019
Closed
xuwei-k
xuwei-k reviewed Jul 31, 2019
View reviewed changes
build.sbt Outdated Show resolved Hide resolved
@ashawley ashawley added the documentation No code change. Only documentation label Aug 15, 2019
@ashawley
Copy link
Member Author

Squashing and rebasing...

@ashawley ashawley mentioned this pull request Aug 20, 2019
Merged
SethTisue
SethTisue reviewed Aug 21, 2019
View reviewed changes
build.sbt
@@ -175,6 +175,16 @@ lazy val commonSettings = instanceSettings ++ clearSourceAndResourceDirectories
),
//maxErrors := 10,
setIncOptions,
// http://stackoverflow.com/questions/16934488
apiMappings ++= {
Option(System.getProperty("sun.boot.class.path")).flatMap { classPath =>
Copy link
Member

@SethTisue SethTisue Aug 21, 2019 •
edited

Choose a reason for hiding this comment

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

This returns None on JDK 11. Switching to JDK 11 as our main build/test/publish environment is eons off, so I don't think it makes the PR unmergeable. I see over at https://github.com/ThoughtWorksInc/sbt-api-mappings/pull/13/files they made it print a warning in this case. If not a warning, perhaps it merits at least a comment?

Copy link
Member Author

Choose a reason for hiding this comment

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

I figured a warning would just be ignored, but it could also double as a code comment, so I'll add a warning.

Copy link
Member Author

@ashawley ashawley Aug 21, 2019 •
edited

Choose a reason for hiding this comment

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

It would be cool if that if the API mappings were to stop working for a release, either for this snippet or for some unforeseen reason, and it would be fatal. I wasn't sure how to guarantee that they're working, though.

@ashawley ashawley mentioned this pull request Aug 22, 2019
Merged
@szeiger
Copy link
Member

szeiger commented Aug 30, 2019

@SethTisue Are you satisfied with the current version?

@SethTisue SethTisue merged commit d0bd824 into scala:2.13.x Aug 30, 2019
@SethTisue
Copy link
Member

thank you Aaron for your attention to this, I think it's a significant usability win

@ashawley
Copy link
Member Author

I hope so. Thanks for reviewing and accepting the fix.

@ashawley ashawley deleted the scaladoc-java-refs branch August 30, 2019 16:26
@szeiger szeiger added the release-notes worth highlighting in next release notes label Sep 9, 2019
@ashawley ashawley mentioned this pull request May 4, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SethTisue SethTisue SethTisue left review comments

@xuwei-k xuwei-k xuwei-k left review comments

Assignees
No one assigned
Labels
documentation No code change. Only documentation release-notes worth highlighting in next release notes
Projects
None yet
Milestone
2.13.1
5 participants
@ashawley @szeiger @SethTisue @xuwei-k @scala-jenkins