Skip to content
This repository was archived by the owner on Apr 11, 2019. It is now read-only.

Commit dcb46e0

Browse files
author
José Valim
committed
Improve more docs
1 parent 558b01d commit dcb46e0

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

lib/registry.ex

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
defmodule Registry do
2-
@moduledoc """
2+
@moduledoc ~S"""
33
A local, decentralized and scalable key-value process storage.
44
55
It allows developers to lookup one or more process with a given key.
@@ -218,7 +218,8 @@ defmodule Registry do
218218
219219
* `:partitions` - the number of partitions in the registry. Defaults to 1.
220220
* `:listeners` - a list of named processes which are notified of `:register`
221-
and `:unregister` events
221+
and `:unregister` events. The registered process must be monitored by the
222+
listener if it wants to be notified of crashes.
222223
* `:meta` - a keyword list of metadata to be attached to the registry.
223224
224225
"""

0 commit comments

Comments
 (0)