DOC: testing.assert_array_equal: distinguish from assert_equal #24875
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
The documentation of `assert_array_equal` and `assert_equal` did not identify the differences between the two. This clarifies that `assert_equal` has a superset of `assert_array_equal` functionality and suggests use of `assert_equal` in new code.
rgommers
approved these changes
Oct 14, 2023
There was a problem hiding this comment.
This language LGTM and renders well. @ngoldbaum was also happy with this version in the discussion on gh-8457.
It was discussed in the community meeting, and there were some concerns about moving assert_array_equal to the list of legacy functions. So it looks like this PR is good to go - in it goes. Thanks for working through this @mdhaber!
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.
Closes gh-8457
The documentation of
assert_array_equalandassert_equaldid not identify the differences between the two. This clarifies thatassert_equalhas a superset ofassert_array_equalfunctionality and suggests favoringassert_equalin new code.I forgot to skip all but doc builds this time. Oops!