summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosé Valim <jose.valim@dashbit.co>2022-11-09 19:12:52 +0100
committerJosé Valim <jose.valim@dashbit.co>2022-11-09 19:13:29 +0100
commitd1f74579072ce629febdcff90fb3bdadd7552070 (patch)
treefc4013d01073b4ddfd9f0d04bf4ab5a4e41cb594
parent123034569f3f80a8693efb33ba8d211048b37507 (diff)
downloadelixir-d1f74579072ce629febdcff90fb3bdadd7552070.tar.gz
Document register
-rw-r--r--lib/ex_unit/lib/ex_unit/case.ex3
1 files changed, 3 insertions, 0 deletions
diff --git a/lib/ex_unit/lib/ex_unit/case.ex b/lib/ex_unit/lib/ex_unit/case.ex
index 503549a83..a33eb3de3 100644
--- a/lib/ex_unit/lib/ex_unit/case.ex
+++ b/lib/ex_unit/lib/ex_unit/case.ex
@@ -20,6 +20,9 @@ defmodule ExUnit.Case do
It should be enabled only if tests do not change any global state.
Defaults to `false`.
+ * `:register` - when `false`, does not register this module within
+ ExUnit server. This means the module won't run when ExUnit suite runs.
+
This module automatically includes all callbacks defined in
`ExUnit.Callbacks`. See that module for more information on `setup`,
`start_supervised`, `on_exit` and the test process life cycle.