Skip to content

Improving docs: Add note section to Process.exit/2 to make it clear #14238

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
merged 3 commits into from
Jan 29, 2025
Merged

Improving docs: Add note section to Process.exit/2 to make it clear #14238

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
60d8256
Add note section to Process.exit/2 to make it clear
fcevado Jan 28, 2025
ea76250
Update lib/elixir/lib/process.ex
josevalim Jan 29, 2025
ab8de7e
Update lib/elixir/lib/process.ex
josevalim Jan 29, 2025
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
10 changes: 10 additions & 0 deletions lib/elixir/lib/process.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,16 @@ defmodule Process do

Inlined by the compiler.

> #### Note {: .info }
>
> The functions `Kernel.exit/1` and `Process.exit/2` are
> named similarly but provide very different functionalities. The
> `Kernel:exit/1` function should be used when the intent is to stop the current
> process while `Process.exit/2` should be used when the intent is to send an
> exit signal to another process. Note also that `Kernel.exit/1` can be caught
> with `try/1` while `Process.exit/2` can only be handled by trapping exits and
> when the signal is different than `:kill`.

## Examples

Process.exit(pid, :kill)
Expand Down