Skip to content

Correct Process.spawn monitor options in typespecs and documentation #16083

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
josevalim merged 1 commit into from
Nov 8, 2026
+9 −9
Merged

Correct Process.spawn monitor options in typespecs and documentation #16083

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 9 additions & 9 deletions lib/elixir/lib/process.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ defmodule Process do
@type spawn_opt ::
:link
| :monitor
| {:monitor, :erlang.monitor_option()}
| {:monitor, [:erlang.monitor_option()]}
| {:priority, :low | :normal | :high}
| {:fullsweep_after, non_neg_integer}
| {:min_heap_size, non_neg_integer}
Expand All @@ -484,10 +484,10 @@ defmodule Process do
@doc """
Spawns the given function according to the given options.

The result depends on the given options. In particular,
if `:monitor` is given as an option, it will return a tuple
containing the PID and the monitoring reference, otherwise
just the spawned process PID.
The result depends on the given options. If `:monitor` or
`{:monitor, monitor_opts}` is given, returns a tuple containing
the PID and the monitoring reference. Otherwise, returns
only the spawned process PID.

More options are available; for the comprehensive list of available options
check `:erlang.spawn_opt/4`.
Expand All @@ -509,10 +509,10 @@ defmodule Process do
Spawns the given function `fun` from module `mod`, passing the given `args`
according to the given options.

The result depends on the given options. In particular,
if `:monitor` is given as an option, it will return a tuple
containing the PID and the monitoring reference, otherwise
just the spawned process PID.
The result depends on the given options. If `:monitor` or
`{:monitor, monitor_opts}` is given, returns a tuple containing
the PID and the monitoring reference. Otherwise, returns
only the spawned process PID.

It also accepts extra options, for the list of available options
check `:erlang.spawn_opt/4`.
Expand Down