Skip to content

Commit efcb90b

Browse files
committed
Document noproc behaviour in start_link_supervised!, see #11737
1 parent 1457728 commit efcb90b

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

lib/ex_unit/lib/ex_unit/callbacks.ex

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -551,8 +551,11 @@ defmodule ExUnit.Callbacks do
551551
@doc """
552552
Same as `start_supervised!/2` but links the started process to the test process.
553553
554-
This means that if the process that was started crashes that crash is propagated to
555-
the test process, failing the test and printing the cause of the crash.
554+
If the process that was started crashes, the crash is propagated to the test process,
555+
failing the test and printing the cause of the crash.
556+
557+
Note that if the started terminates before it is linked to the test process,
558+
this function will exit with reason `:noproc`.
556559
"""
557560
@doc since: "1.14.0"
558561
@spec start_link_supervised!(Supervisor.child_spec() | module | {module, term}, keyword) ::

0 commit comments

Comments
 (0)