Rename shutdownGracefully to triggerGracefulShutdown on the ServiceGroup
#142
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…iceGroup` # Motivation The current naming of `shutdownGracefully()` on the `ServiceGroup` caused some confusion since callers had to `await` the call due the `ServiceGroup` being an `actor`. This lead users to believe that the method waited until the graceful shutdown was completed; however, the method only triggered the shutdown and exited. # Modification This PR renames `ServiceGroup/shutdownGracefully()` to `ServiceGroup/triggerGracefulShtudown()`. # Result Less confusion around the behaviour of triggering a graceful shutdown on the `ServiceGroup`.
gjcairo
approved these changes
May 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The current naming of
shutdownGracefully()on theServiceGroupcaused some confusion since callers had toawaitthe call due theServiceGroupbeing anactor. This lead users to believe that the method waited until the graceful shutdown was completed; however, the method only triggered the shutdown and exited.Modification
This PR renames
ServiceGroup/shutdownGracefully()toServiceGroup/triggerGracefulShtudown().Result
Less confusion around the behaviour of triggering a graceful shutdown on the
ServiceGroup.