From 1819b3aff71f49087e98c671e3ce3a388be98543 Mon Sep 17 00:00:00 2001
From: Adam Kocoloski <adam@cloudant.com>
Date: Mon, 10 May 2010 21:14:25 -0400
Subject: Better docs for rexi_monitor

---
 src/rexi_monitor.erl | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/rexi_monitor.erl b/src/rexi_monitor.erl
index b4c00f23..7e16048c 100644
--- a/src/rexi_monitor.erl
+++ b/src/rexi_monitor.erl
@@ -4,7 +4,8 @@
 -include_lib("eunit/include/eunit.hrl").
 
 %% @doc spawn_links a process which monitors the supplied list of items and
-%% returns the process ID.
+%% returns the process ID.  If a monitored process exits, the caller will
+%% receive a {rexi_DOWN, MonitoringPid, DeadPid, Reason} message.
 -spec start([pid() | atom() | {atom(),atom()}]) -> pid().
 start(Procs) ->
     Parent = self(),
-- 
cgit v1.2.3