Supervisor.start_link/2 documentation incomplete?

[peerreynders]

It is this type of thing why I would give priority to

[Erlang] Designing for Scalability with Erlang/OTP (O'Reilly)

over

The Little Elixir & OTP Guidebook (Manning)

---

This goes back to the Erlang documentation:

http://erlang.org/doc/man/supervisor.html#start_link-2

Args is any term that is passed as the argument to Module:init/1.

• If the supervisor and its child processes are successfully created (that is, if all child process start functions return {ok,Child}, {ok,Child,Info}, or ignore), the function returns {ok,Pid}, where Pid is the pid of the supervisor.
• If there already exists a process with the specified SupName, the function returns {error,{already_started,Pid}}, where Pid is the pid of that process.
• If Module:init/1 returns ignore, this function returns ignore as well, and the supervisor terminates with reason normal.
• If Module:init/1 fails or returns an incorrect value, this function returns {error,Term}, where Term is a term with information about the error, and the supervisor terminates with reason Term.
• If any child process start function fails or returns an error tuple or an erroneous value, the supervisor first terminates all already started child processes with reason shutdown and then terminate itself and returns{error, {shutdown, Reason}}.