Resolve all scaladoc link warnings - #55
Merged
Merged
Conversation
The doc task emitted 20 "Couldn't resolve a member for the given link
query" warnings, visible in publish runs since those build javadoc jars.
Every target existed; each was a resolution-scope problem.
Two causes, two fixes:
Bare member links in a doc comment attached to the enclosing enum or
class do not resolve ([[Raw]] from enum Cron's own comment). Qualifying
them fixes it, as does qualifying cross-module links fully
([[Capability.deploy]] in the plugin becomes
[[zipx.core.Capability.deploy]]).
Six targets are genuinely outside any doc classpath: test sources
(PlannerSpec), an external library (Yaml, from zio-blocks), and
zipx.specular.ZipxDocs / zipx.sbt, which sit downstream of core given
workflow <- core <- {central, sbt-plugin}. Those become backticks,
matching the convention already used beside them (RemoteCacheProof
referenced a broken [[PlannerSpec]] next to a working `RemoteCacheItSpec`).
Comments only. `doc` now warns only about "Option -classpath was
updated", an sbt notice that is not actionable.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The
doctask emitted 20Couldn't resolve a member for the given link querywarnings. They show up in publish runs because those build javadoc jars;compileis clean, which is why they went unnoticed.Every one of the 20 targets existed. None was a typo. All 20 were scaladoc resolution scope problems.
Two causes
Bare member links (14). Scala 3 scaladoc will not resolve
[[Raw]]fromenum Cron's own doc comment, but resolves[[Cron.Raw]]fine. Same shape forDefaults,LocalDir,Fixed,GitTags,Script,AffectedOnly,Always.Cross-module links (6 fixed by qualification). The short form does not resolve across modules but the fully-qualified form does:
[[Workflow]]becomes[[zipx.workflow.Workflow]]from core, and[[Capability.deploy]]becomes[[zipx.core.Capability.deploy]]from the plugin.The unreachable remainder (6, converted to backticks)
These target things that can never be on the module's doc classpath:
PlannerSpec, a test source.Yaml, from external zio-blocks.zipx.specular.ZipxDocs/.pagesandzipx.sbt, which sit downstream of core given theworkflow<-core<- {central,sbt-plugin} direction, so a link from core can never reach them.Backticks match the convention already in that prose:
RemoteCacheProofcarried a broken[[PlannerSpec]]directly beside a working`RemoteCacheItSpec`.Verification
sbt "cleanFull; doc"now reports zero link warnings. The only remaining output isOption -classpath was updated(x4, one per module runningdoc), an sbt notice that is not actionable.scalafmtCheckAllclean. The longer qualified names pushed several comment lines pastmaxColumn = 120, soscalafmtAllreflowed 7 files;docwas re-run after the reflow to confirm the wrapping did not break a link.core/workflow/central/docs(testFull, nottestQuick).zipxWorkflowCheckclean.Comments only; no code path is touched.