arun2dot0 opened a new pull request, #3064:
URL: https://github.com/apache/pekko/pull/3064

   ### Motivation
   `sbt unidoc` emits `Could not find any member to link for "ShardRegion"` 
warnings across the `cluster-sharding` module. The bare `[[ShardRegion]]` links 
refer to the `ShardRegion` *actor*, which is the `private[pekko] class 
ShardRegion` and therefore is not part of the generated API docs, so scaladoc 
cannot resolve the link.
   
   ### Modification
   Replace the bare `[[ShardRegion]]` actor references with backticked 
`ShardRegion` in `ClusterSharding.scala`, `ShardRegion.scala`, and 
`ShardCoordinator.scala`. This matches the existing local style (these files 
already refer to the actor as `ShardRegion` in prose) and the approach taken in 
#2780. Qualified links that resolve correctly (e.g. 
`[[ShardRegion.Passivate]]`, `[[ShardRegion.MessageExtractor]]`) are left 
untouched.
   
   ### Result
   The 18 `Could not find any member to link for "ShardRegion"` warnings in the 
`cluster-sharding` module are gone.
   
   ### Tests
   - `sbt -Dpekko.scaladoc.diagrams=false "cluster-sharding/doc"` - success, 0 
`ShardRegion` link warnings remaining (docs only)
   - `sbt "cluster-sharding/scalafmtCheck"` - success
   - `git diff --check` - clean
   
   ### References
   Refs #353


-- 
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]

Reply via email to