File tree 1 file changed +11
-4
lines changed 1 file changed +11
-4
lines changed Original file line number Diff line number Diff line change 1
1
defmodule Exception do
2
2
@ moduledoc """
3
- Functions to format throw/catch/exit and exceptions.
3
+ Functions for dealing with throw/catch/exit and exceptions.
4
4
5
- Note that stacktraces in Elixir are only available inside
6
- catch and rescue by using the `__STACKTRACE__/0` variable .
5
+ This module also defines the behaviour required by custom
6
+ exceptions. To define your own, see `defexception/1` .
7
7
8
- Do not rely on the particular format returned by the `format*`
8
+ ## Formatting functions
9
+
10
+ Several functions in this module help format exceptions.
11
+ Some of these functions expect the stacktrace as argument.
12
+ The stacktrace is typically available inside catch and
13
+ rescue by using the `__STACKTRACE__/0` variable.
14
+
15
+ Do not rely on the particular format returned by the
9
16
functions in this module. They may be changed in future releases
10
17
in order to better suit Elixir's tool chain. In other words,
11
18
by using the functions in this module it is guaranteed you will
You can’t perform that action at this time.
0 commit comments