[GH] (pekko/fix-scaladoc-link-warnings-353): Workflow run "Pull Requests" failed!

[GitBox <gi...@apache.org>]

The GitHub Actions job "Pull Requests" on pekko.git/fix-scaladoc-link-warnings-353 has failed.
Run started by GitHub user henricook (triggered by He-Pin).

Head commit for run:
042932e11e29e7147d7cb5703fdc3546816fd21d / Henri Cook <gi...@henricook.com>
Fix a few broken Scaladoc links reported by unidoc #353

Motivation:
sbt unidoc reports many "Could not find any member to link for" warnings
(#353). A few are simply broken links rather than the trickier private or
ambiguous-target cases: Tcp's SimpleWriteCommand and CompoundWrite still link
[[WriteFile]], but that command was renamed to WritePath; and ShardingEnvelope's
@throws tag wraps the exception type in [[ ]], which Scaladoc does not parse for
@throws.

Modification:
- Tcp.scala: [[WriteFile]] -> [[WritePath]] in two Scaladoc comments.
- ShardingMessageExtractor.scala: drop the [[ ]] from the @throws tag so it
  follows 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. Verified with sbt unidoc that the three warnings are gone
and no new warnings appear; sbt scalafmtCheck passes for the two modules.

References:
Refs #353

Report URL: https://github.com/apache/pekko/actions/runs/27948944783

With regards,
GitHub Actions via GitBox


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org