diff options
| author | Sverker Eriksson <[email protected]> | 2018-03-02 18:49:29 +0100 |
|---|---|---|
| committer | Sverker Eriksson <[email protected]> | 2018-03-02 19:16:48 +0100 |
| commit | b0860754c392a591389f5f35ee5458758f6db10f (patch) | |
| tree | bb690e27e56356d97a6fa1436e973589f3d62f8f | |
| parent | 3e580e039a8eb2467c638503bc526116fe829fec (diff) | |
| download | otp-b0860754c392a591389f5f35ee5458758f6db10f.tar.gz otp-b0860754c392a591389f5f35ee5458758f6db10f.tar.bz2 otp-b0860754c392a591389f5f35ee5458758f6db10f.zip | |
erts: Improve send/2 docs
with link to ! operator
and clarify ugly badarg for unregistered atom argument.
| -rw-r--r-- | erts/doc/src/erlang.xml | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml index 771897ba94..ff0480291b 100644 --- a/erts/doc/src/erlang.xml +++ b/erts/doc/src/erlang.xml @@ -5700,11 +5700,17 @@ true</pre> <type name="dst"/> <desc> <p>Sends a message and returns <c><anno>Msg</anno></c>. This - is the same as <c><anno>Dest</anno> ! <anno>Msg</anno></c>.</p> + is the same as using the <seealso marker="doc/reference_manual:expressions#send"> + send operator</seealso>: + <c><anno>Dest</anno> ! <anno>Msg</anno></c>.</p> <p><c><anno>Dest</anno></c> can be a remote or local process identifier, a (local) port, a locally registered name, or a tuple <c>{<anno>RegName</anno>, <anno>Node</anno>}</c> - for a registered name at another node.</p> + for a registered name at another node.</p> + <p>The function fails with a <c>badarg</c> run-time error if + <c><anno>Dest</anno></c> is an atom name, but this name is not + registered. This is the only case when <c>send</c> fails for an + unreachable destination <c><anno>Dest</anno></c> (of correct type).</p> </desc> </func> |