assert: Correctly document EqualValues behavior #1593
Merged
Conversation
This file contains 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
|
I like your proposal. |
arjunmahishi
approved these changes
May 10, 2024
dolmen
added
documentation
pkg-assert
dolmen
approved these changes
May 16, 2024
dolmen
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
The EqualValues docstring is ambiguous to how it actually behaves, this docstring more concisely describes the current behavior.
Changes
Update docstring for all EqualValues functions
Motivation
The ambiguity caused issues, such as #1576 where an update changed the arguably broken behaviour without breaking the ambiguous contract.
Related issues
#1576 this does not necessarily resolve the issue, nor does it preclude reverting the behavior. The aim here is only to make the documentation match the current behaviour.