Skip to content

Commit

Permalink
Make the docs for Task.Supervisor slightly more clear
Browse files Browse the repository at this point in the history
This could improve situations like the one happened in elixir-lang#5225.
  • Loading branch information
whatyouhide committed Sep 19, 2016
1 parent 810965e commit 9796d16
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions lib/elixir/lib/task/supervisor.ex
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ defmodule Task.Supervisor do
This module defines a supervisor which can be used to dynamically
supervise tasks. Behind the scenes, this module is implemented as a
`:simple_one_for_one` supervisor where the workers are temporary
(i.e. they are not restarted after they die).
`:simple_one_for_one` supervisor where the workers are temporary by
default (that is, they are not restarted after they die; read the docs
for `start_link/1` for more information on choosing the restart
strategy).
See the `Task` module for more information.
## Name Registration
## Name registration
A `Task.Supervisor` is bound to the same name registration rules as a
`GenServer`. Read more about them in the `GenServer` docs.
Expand Down

0 comments on commit 9796d16

Please sign in to comment.