Add documentation for ZIOApp#gracefulShutdownTimeout
#9923
Merged
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the ZIOApp documentation by introducing a new section on graceful shutdown timeout behavior.
- Added a new documentation section "Graceful Shutdown Timeout" explaining the default behavior and how to override it.
- Included a Scala code snippet demonstrating how to set a shutdown timeout.
Comments suppressed due to low confidence (1)
docs/reference/core/zioapp.md:138
- The error message refers to 'shutdownTimeout' rather than 'gracefulShutdownTimeout'. Please update the method name in the message for consistency with the documented override.
Timed out waiting for ZIO application to shut down after 30 seconds. You can adjust your application's shutdown timeout by overriding the `shutdownTimeout` method
kyri-petrou
reviewed
Jun 3, 2025
… clarify default behavior
kyri-petrou
reviewed
Jun 4, 2025
Co-authored-by: kyri-petrou <[email protected]>
Co-authored-by: kyri-petrou <[email protected]>
|
@kyri-petrou looks like there is an unrelated test failure in CI. |
aadarsh-nagrath
added a commit
to aadarsh-nagrath/zio
that referenced
this pull request
Jun 6, 2025
zio#9923) - Add comprehensive documentation for gracefulShutdownTimeout method - Improve note styling with concise, clear formatting - Document platform-specific behavior (JVM, Scala Native, Scala.js) - Add examples for common use cases (database, HTTP server) - Include best practices for timeout configuration and resource management
kyri-petrou
approved these changes
Jun 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
/claim #9913
Fixes #9913