Skip to content

Improve Supervisor docs and specs #7871

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 2 commits into from
Jul 11, 2018
Merged

Improve Supervisor docs and specs #7871

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a768263
Improve Supervisor docs and specs
eksperimental Jul 11, 2018
5accc4f
Update supervisor.ex
josevalim Jul 11, 2018
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
19 changes: 9 additions & 10 deletions lib/elixir/lib/supervisor.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,10 @@ defmodule Supervisor do
The child specification describes how the supervisor starts, shuts down,
and restarts child processes.

The child specification contains 5 keys. The first two are required,
The child specification contains 6 keys. The first two are required,
and the remaining ones are optional:

* `:id` - a value used to identify the child specification
* `:id` - any term used to identify the child specification
internally by the supervisor; defaults to the given module.
In the case of conflicting `:id` values, the supervisor will refuse
to initialize and require explicit IDs. This key is required.
Expand Down Expand Up @@ -338,7 +338,7 @@ defmodule Supervisor do
restarts in transient mode, and linked processes exit with the same
reason unless they're trapping exits

Notice that supervisor that reached maximum restart intensity will exit with
Notice that the supervisor that reaches maximum restart intensity will exit with
`:shutdown` reason. In this case the supervisor will only be restarted if its
child specification was defined with the `:restart` option set to `:permanent`
(the default).
Expand Down Expand Up @@ -390,7 +390,7 @@ defmodule Supervisor do
can run as a child of another supervision in the tree. The generated
`child_spec/1` can be customized with the following options:

* `:id` - the child specification id, defaults to the current module
* `:id` - the child specification identifier, defaults to the current module
* `:start` - how to start the child process (defaults to calling `__MODULE__.start_link/1`)
* `:restart` - when the supervisor should be restarted, defaults to `:permanent`

Expand Down Expand Up @@ -440,10 +440,9 @@ defmodule Supervisor do
processes are terminated and then all child processes (including
the terminated one) are restarted.

* `:rest_for_one` - if a child process terminates, the "rest" of
the child processes, i.e., the child processes after the terminated
one in start order, are terminated. Then the terminated child
process and the rest of the child processes are restarted.
* `:rest_for_one` - if a child process terminates, the terminated child
process and the rest of the children started after it, are terminated and
restarted.

In the above, process termination refers to unsuccessful termination, which
is determined by the `:restart` option.
Expand All @@ -452,7 +451,7 @@ defmodule Supervisor do
has been replaced by the `DynamicSupervisor`. The `:simple_one_for_one`
supervisor was similar to `:one_for_one` but suits better when dynamically
attaching children. Many functions in this module behaved slightly
differently when this strategy is used. See the `DynamicSupervisor` module
differently when this strategy was used. See the `DynamicSupervisor` module
for more information and migration strategies.

## Name registration
Expand Down Expand Up @@ -534,7 +533,7 @@ defmodule Supervisor do
# Note we have inlined all types for readability
@typedoc "The supervisor specification"
@type child_spec :: %{
required(:id) => term(),
required(:id) => atom() | term(),
required(:start) => {module(), atom(), [term()]},
optional(:restart) => :permanent | :transient | :temporary,
optional(:shutdown) => timeout() | :brutal_kill,
Expand Down