Skip to content

Improve documentation for at_exit handler conditions #14426

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.

Sign up for GitHub

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

Merged
straight-shoota merged 2 commits into from
Apr 8, 2024
Merged

Improve documentation for at_exit handler conditions #14426

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e263bda
Improve documentation for `at_exit` handlers
straight-shoota Apr 3, 2024
e7d83f4
Fix format
straight-shoota Apr 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion src/kernel.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,16 @@ def pp(**objects)
pp(objects) unless objects.empty?
end

# Registers the given `Proc` for execution when the program exits.
# Registers the given `Proc` for execution when the program exits regularly.
#
# A regular exit happens when either
# * the main fiber reaches the end of the program,
# * the main fiber rescues an unhandled exception, or
# * `::exit` is called.
#
# `Process.exit` does *not* trigger `at_exit` handlers, nor does external process
# termination (see `Process.on_terminate` for handling that).
#
# If multiple handlers are registered, they are executed in reverse order of registration.
#
# ```
Expand Down