Skip to content

Commit 60d8256

Browse files
committed
Add note section to Process.exit/2 to make it clear
1 parent bea1c6c commit 60d8256

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

lib/elixir/lib/process.ex

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,16 @@ defmodule Process do
219219
220220
Inlined by the compiler.
221221
222+
> #### Note {: .info }
223+
>
224+
> The functions `Kernel.exit/1` and `Process.exit/2` are
225+
> named similarly but provide very different functionalities. The
226+
> `Kernel:exit/1` function should be used when the intent is to stop the current
227+
> process while `Process:exit/2` should be used when the intent is to send an
228+
> exit signal to another process. Note also that `Kernel:exit/1` raises an
229+
> exception that can be caught while `Process:exit/2` does not cause any
230+
> exception to be raised.
231+
222232
## Examples
223233
224234
Process.exit(pid, :kill)

0 commit comments

Comments
 (0)