aboutsummaryrefslogtreecommitdiffstats
path: root/include/relcool.hrl
diff options
context:
space:
mode:
Diffstat (limited to 'include/relcool.hrl')
-rw-r--r--include/relcool.hrl7
1 files changed, 7 insertions, 0 deletions
diff --git a/include/relcool.hrl b/include/relcool.hrl
index 732e5d3..11a0dec 100644
--- a/include/relcool.hrl
+++ b/include/relcool.hrl
@@ -18,3 +18,10 @@
-define(RCL_ERROR, 0).
-define(RCL_INFO, 1).
-define(RCL_DEBUG, 2).
+
+%% This is the default form of error messages for the Relcool
+%% system. It is expected that everything that returns an error use
+%% this and that they all expose a format_error/1 message that returns
+%% an iolist.
+-define(RCL_ERROR(Reason),
+ {error, {?MODULE, Reason}}).