Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for catsEffectReleaseTimeout #320

Merged
merged 3 commits into from
Mar 8, 2024

Conversation

michaltomanski
Copy link
Collaborator

The catsEffectReleaseTimeout is applicable to the Akka/Pekko coordinated shutdown task, which is added to a specific phase. The phase timeout is configured separately via config files of Akka/Pekko. The timeout of a single task should not be higher than the timeout of the related phase.

Plus some minor fixes.

Michal Tomanski and others added 3 commits March 8, 2024 15:26
It is recommended that the timeout set on a task attached to a specific Akka or Pekko coordinated shutdown phase is not higher than the timeout of the phase itself.
Copy link

what-the-diff bot commented Mar 8, 2024

PR Summary

  • Refactoring property names in configurations
    The property names akka.coordinated-shutdown.exit-jvm and pekko.coordinated-shutdown.exit-jvm were simplified to coordinated-shutdown.exit-jvm in both Akka and Pekko systems. This should make configurations easier to understand.

  • Expanded and Updated Comments
    The comments in several parts of the code have been improved, resulting in better documentation. Specifically, the descriptors for catsEffectReleaseTimeout, akkaReleaseTimeout, sharding and askTimeout parameters have been clarified in AkkaCluster, ShardingCommandSender, and PekkoCluster, respectively. These improvements will make it easier to understand how these parameters are used and their role within the overall system.

@jchapuis jchapuis merged commit 2988776 into endless4s:master Mar 8, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants