henricook opened a new pull request, #3120:
URL: https://github.com/apache/pekko/pull/3120
### Motivation
`sbt unidoc` emits a number of "Could not find any member to link for"
Scaladoc
warnings (#353). A few of these are plain broken links rather than the
trickier
private or ambiguous-target cases:
- `Tcp`'s `SimpleWriteCommand` and `CompoundWrite` Scaladoc link
`[[WriteFile]]`,
but that write command was renamed to `WritePath`.
- `ShardingEnvelope`'s `@throws` tag wraps the exception type in `[[ ]]`.
Scaladoc
does not parse `[[ ]]` inside `@throws`, so the link is reported as
missing.
### Modification
- `Tcp.scala`: update two Scaladoc comments from `[[WriteFile]]` to
`[[WritePath]]`.
- `ShardingMessageExtractor.scala`: remove the `[[ ]]` around the `@throws`
type so
it matches the `@throws <fully.qualified.type> <description>` form used
elsewhere.
### Result
Three unidoc link warnings are resolved. No API or behaviour change.
### Tests
Not run - docs only. Confirmed locally with `sbt unidoc` that the three
warnings no
longer appear and no new warnings were introduced; `sbt scalafmtCheck`
passes for
both touched modules.
### References
Refs #353
I kept this small on purpose, following your note on #353 about manageable
PRs.
Happy to follow up with the other warning categories (ambiguous link targets
and so
on) in separate PRs if that's useful.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
