diff options
| author | Eksperimental <eksperimental@users.noreply.github.com> | 2018-07-11 14:47:58 +0700 |
|---|---|---|
| committer | José Valim <jose.valim@gmail.com> | 2018-07-11 09:47:58 +0200 |
| commit | d5e244611c222ee1533f93bcdaf43b7caf92ec6a (patch) | |
| tree | 26baec5b4719937119c705ff59b5049de6fc1280 | |
| parent | 260dde330f854a5983656360559d4e8a716a9b8b (diff) | |
| download | elixir-d5e244611c222ee1533f93bcdaf43b7caf92ec6a.tar.gz | |
Be precise in documentation about after values in Kernel.SpecialForms.receive/1 (#7856)
* 4_294_967_295 is still a valid number
* it is not correct to say that :infinity is the same as not using a timeout value,
as this is needed if used the after clause. To what's equivalent is as to not to
use the after clause itself.
* use the formal name "hexadecimal notation" in favor of "hex notation"
[ci skip]
| -rw-r--r-- | lib/elixir/lib/kernel/special_forms.ex | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/lib/elixir/lib/kernel/special_forms.ex b/lib/elixir/lib/kernel/special_forms.ex index f07616375..d6e075028 100644 --- a/lib/elixir/lib/kernel/special_forms.ex +++ b/lib/elixir/lib/kernel/special_forms.ex @@ -2025,13 +2025,13 @@ defmodule Kernel.SpecialForms do one of the allowed values: * `:infinity` - the process should wait indefinitely for a matching - message, this is the same as not using a timeout + message, this is the same as not using the after clause * `0` - if there is no matching message in the mailbox, the timeout will occur immediately - * positive integer smaller than `4_294_967_295` (`0xFFFFFFFF` - in hex notation) - it should be possible to represent the timeout + * positive integer smaller than or equal to `4_294_967_295` (`0xFFFFFFFF` + in hexadecimal notation) - it should be possible to represent the timeout value as an unsigned 32-bit integer. ## Variables handling |