summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJosé Valim <jose.valim@plataformatec.com.br>2015-10-04 15:39:00 -0500
committerJosé Valim <jose.valim@plataformatec.com.br>2015-10-04 15:58:34 -0500
commit9bcd8439e7ff0277fb27b9a0af9a61434222674d (patch)
treeaeb369ad0d947d8087b8de6bbd2bf17a24c9f217
parent40fff43ea02e5991d18ae2023a8c32087f174d8e (diff)
downloadelixir-9bcd8439e7ff0277fb27b9a0af9a61434222674d.tar.gz
Tidy up GenServer docs
-rw-r--r--lib/elixir/lib/gen_server.ex10
1 files changed, 4 insertions, 6 deletions
diff --git a/lib/elixir/lib/gen_server.ex b/lib/elixir/lib/gen_server.ex
index f99f6ddde..7aff74e53 100644
--- a/lib/elixir/lib/gen_server.ex
+++ b/lib/elixir/lib/gen_server.ex
@@ -77,12 +77,10 @@ defmodule GenServer do
* `{:via, module, term}` - the GenServer is registered with the given
mechanism and name. The `:via` option expects a module that exports
- `register_name/2`, `unregister_name/1`, `whereis_name/1` and `send/2`
- functions implemented in `:global` module. These functions are
- responsible for keeping the list of names of processes and their
- associated pid's that are available globally for a network of Erlang
- nodes whereas in the module you could choose to register globally or
- local with a custom implementation.
+ `register_name/2`, `unregister_name/1`, `whereis_name/1` and `send/2`.
+ One such example is the `:global` module which uses these functions
+ for keeping the list of names of processes and their associated pid's
+ that are available globally for a network of Erlang nodes.
For example, we could start and register our Stack server locally as follows: