typelevel / typelevel/sbt-typelevel
Incorrect scaladoc links to JDK apidocs
Open
Nobody has claimed this yet.
bug
settings
- Dominant language
- Scala
- Stars
- 185
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
Links to JDK APIs in the generated scaladoc seem to be incorrect. Two examples:
- In the Cats Effect documentation:
java.security.SecureRandomlinks to https://docs.oracle.com/en/java/javase/11/docs/api/java/security/SecureRandom.html (which is a dead link). - Here:
java.util.concurrent.atomic.AtomicReferencelinks to https://docs.oracle.com/en/java/javase/17/docs/api/java/util/concurrent/atomic/AtomicReference.html (which is also a dead link).
In theory this can be an sbt/scaladoc bug, but I see some settings here, which seem related, but somehow they're not applied(?).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Inspect settings/src/main/scala/org/typelevel/sbt/TypelevelSettingsPlugin.scala around line 368 and compare the relevant settings with the generated scaladoc linked in the issue. Reproduce the JDK API links and trace whether those settings are applied; the work is done when generated links for java.security.SecureRandom and java.util.concurrent.atomic.AtomicReference resolve correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, scala
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100