DOC: Clarify that np.char comparison functions always return ndarrays#17036
Merged
mattip merged 2 commits intonumpy:masterfrom Aug 11, 2020
Merged
DOC: Clarify that np.char comparison functions always return ndarrays#17036mattip merged 2 commits intonumpy:masterfrom
np.char comparison functions always return ndarrays#17036mattip merged 2 commits intonumpy:masterfrom
Conversation
np.rec comparison functions always return ndarraysnp.char comparison functions always return ndarrays
rossbar
approved these changes
Aug 10, 2020
Contributor
rossbar
left a comment
There was a problem hiding this comment.
LGTM - the current docs do seem to be incorrect.
Member
|
Thanks @BvB93 |
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
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 docstring of
np.char.equal(), and all other comparison functions in thenp.charmodule, incorrectly claim that a boolean is returned if two scalars are compared. This is incorrect, as the respective function(s) always return anndarray(0d in the case of scalar comparisons).This pull requests thus corrects the docstrings of aforementioned functions.
Examples