Fix some of the scaladoc links #295
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If ones removes the line `Compile / doc / sources := Nil,` from the
build and run `sbt doc` one get warnings like:
```
[warn] -- Warning: modules/deriving/src/main/scala/shapeless3/deriving/kinds.scala:66:7
[warn] 66 | type Kind[M <: Mirror, O <: Up] = (M of O) { type Kind = self.type }
[warn] | ^
[warn] | Couldn't resolve a member for the given link query: Mirror
```
Based on the dicussion in scala/scala3#20028
my understanding is that this means that scaldoc can not resolve the
existing link.
The reason I want to fix this is that it will also show up for users
implementing custom `Kinds`. E.g in some private project where I extends
Kind I get warnings like this in my scaladoc:
```
[warn] -- Warning: modules/deriving/src/main/scala/shapeless3/deriving/kinds.scala:66:7
[warn] Couldn't resolve a member for the given link query: Mirror
```
(the error changed slighlty in the latest Scala 3 version). Since I
don't think this is solvable for a user I suggest that we just make the
links absolute which seems to solve the warnings.
Member
|
Would also remove that line? Not sure why it's there: Compile / doc / sources := Nil |
Contributor
Author
|
Sure. Removed it in the latest commit. There are also warnings like where we in the docs we want to link to something in shapeless2. Not sure what the correct fix is there. |
joroKr21
approved these changes
Dec 14, 2025
Member
The correct fix would be to not use a link I guess since it won't work anyway - just use format as code |
joroKr21
approved these changes
Dec 15, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
If ones removes the line
Compile / doc / sources := Nil,from the build and runsbt docone get warnings like:Based on the dicussion in scala/scala3#20028 my understanding is that this means that scaldoc can not resolve the existing link.
The reason I want to fix this is that it will also show up for users implementing custom
Kinds. E.g in some private project where I extendsKindI get warnings like this in my scaladoc:(the error changed slighlty in the latest Scala 3 version). Since I don't think this is solvable for a user I suggest that we just make the links absolute which seems to solve the warnings.