Repository navigation
chore: remove stale Akka-era references from Scaladoc and a log message - #3584
Conversation
Motivation: Some Scaladoc and one log message still refer to Akka-era details that are misleading for Pekko users. Modification: - RemoveInternalClusterShardingData: drop the -2.3 flag (for data written by Akka 2.3.x) from the usage example and description, and no longer mention auto-down as a cause of corrupt data - Cluster: the auto-down warning says auto-down is not supported in Pekko instead of "removed in Akka 2.6.0" - Sink.collection Scaladoc: refer to the collection `Factory` instead of `CanBuildFrom` Result: Scaladoc and the warning match Pekko. Tests: - Not run - Scaladoc and log message text only References: Refs apache#3583
He-Pin
left a comment
He-Pin
left a comment
There was a problem hiding this comment.
The auto-down log message change and the Factory fix both look right to me, and I checked that nothing in the repo asserts the old warning text.
| * java -classpath <jar files, including pekko-cluster-sharding> | ||
| * org.apache.pekko.cluster.sharding.RemoveInternalClusterShardingData | ||
| * -2.3 entityType1 entityType2 entityType3 | ||
| * entityType1 entityType2 entityType3 |
There was a problem hiding this comment.
The -2.3 flag is still live: args(0) == "-2.3" at line 77, and remove2dot3Data is a parameter of the public remove method and of the public class constructor. docs/src/main/paradox/typed/cluster-sharding.md:851 also still advertises -2.3. Deleting this paragraph removes the only in-source explanation of the flag and makes the Scaladoc example disagree with both the code and the published docs. Could you keep the paragraph (dropping it from the example is fine), or move the flag removal into a separate PR that also updates the code, the docs and the MiMa filters?
|
Pushed fe4bacf to restore the |
2 participants
Motivation
Some Scaladoc and one log message still refer to Akka-era details that are misleading for Pekko users. These were left out of #3583 because they are in source files.
Modification
RemoveInternalClusterShardingData: drop the-2.3flag (for data written by Akka 2.3.x) from the usage example and description, and no longer mention auto-down as a cause of corrupt data. The flag handling inmainis unchanged.Cluster: the auto-down warning now says auto-down is not supported in Pekko, instead of "auto-down has been removed in Akka 2.6.0".Sink.collectionScaladoc: refer to the collectionFactoryinstead ofCanBuildFrom.Result
Scaladoc and the warning match Pekko.
Tests
References
Refs #3583