doc: mention that receive/1 and ExUnit.Assertions.assert_receive/4 removes messages #14743
Conversation
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
andremaker
changed the title
josevalim
reviewed
Sep 3, 2025
josevalim
reviewed
Sep 3, 2025
Member
|
💚 💙 💜 💛 ❤️ |
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.
These macros are missing an explicit mention of the fact that they remove the first match, which is an important piece of behavior in the documentation.
This behavior detail is often learned indirectly for
receive/1, since most explanations also mention that a matching message is removed from the mailbox. Still, making it explicit in the docs avoids ambiguity.For
assert_receive/3andassert_received/2, the removal is a hidden side effect that may not be noticed, since the focus is on assertion semantics. Calling it out in the docs prevents confusion and makes the behavior clearer.