Fix GenServer.call/3 timeout doc: non-negative, not greater than zero#15568
Merged
josevalim merged 1 commit intoJul 9, 2026
Merged
Conversation
The docs said `timeout` "is an integer greater than zero", but both the colocated guard (`is_integer(timeout) and timeout >= 0`) and the `timeout` typespec (`:infinity | non_neg_integer()`) accept `0` — `GenServer.call(pid, msg, 0)` is a legal call (time out immediately unless a reply is already waiting). The prose was the only place excluding zero; align it with the guard and the typespec. Assisted-by: Claude Code:claude-opus-4-8
Member
|
💚 💙 💜 💛 ❤️ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs said
timeout"is an integer greater than zero", but both the colocated guard (is_integer(timeout) and timeout >= 0) and thetimeouttypespec (:infinity | non_neg_integer()) accept0—GenServer.call(pid, msg, 0)is a legal call (time out immediately unless a reply is already waiting). The prose was the only place excluding zero; align it with the guard and the typespec.Assisted-by: Claude Code:claude-opus-4-8