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

Incorrect scaladoc links to JDK apidocs #592

Open
durban opened this issue Jul 4, 2023 · 8 comments
Open

Incorrect scaladoc links to JDK apidocs #592

durban opened this issue Jul 4, 2023 · 8 comments

Comments

@durban
Copy link

durban commented Jul 4, 2023

Links to JDK APIs in the generated scaladoc seem to be incorrect. Two examples:

In theory this can be an sbt/scaladoc bug, but I see some settings here, which seem related, but somehow they're not applied(?).

@armanbilge
Copy link
Member

Hmm, maybe we forgot to prefix it with Compile /? 🤔

@armanbilge
Copy link
Member

armanbilge commented Jul 4, 2023

No, that seems fine. So now I suspect maybe we are not mapping the right thing 🤔

val newSchool = Map(file("/modules/java.base") -> baseUrl)

FTR that's cargo-culted from here.
https://github.com/scala-js/scala-js/blob/e0afd0f096c6b096ce7ad17f46c07142ac80c7ef/project/Build.scala#L442-L446

@armanbilge
Copy link
Member

I think we should try refreshing our cargo-cult with exactly whats in Scala.js, for example this part seems interesting.

https://github.com/scala-js/scala-js/blob/e0afd0f096c6b096ce7ad17f46c07142ac80c7ef/project/Build.scala#L428-L430

@armanbilge
Copy link
Member

Tried fixing this in 4b8962b but it didn't fix Choam 😕 so either we're still not doing it right, or perhaps sbt is overriding us.

@durban
Copy link
Author

durban commented Jul 6, 2023

Thanks for trying! This whole apiMappings setting is very mysterious to me, so I don't have any ideas...

@durban
Copy link
Author

durban commented Jul 6, 2023

Have we seen this setting working anywhere? I see that in the scala-js API it seems to work; I suspect that's because it uses the old (JVM 8) url...

Edit: what I wrote above is incorrect, I still don't understand what's happening.

@durban
Copy link
Author

durban commented Jul 7, 2023

There is a strange interaction with the -release option, but it doesn't seem sbt-typelevel specific, so I've opened scala/bug#12820.

@armanbilge
Copy link
Member

Aha, I see, thanks for investigating. But this does illustrate our setting is not really doing anything.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants