DOC: Clarify isreal docstring #18843
Conversation
Add clarification to docstring of isreal function, that it returns True for non-numeric inputs. Closes numpy#18814.
…into improve_docstring_isreal
…into improve_docstring_isreal
Add clarification to Notes section Add clarification also as markup to serve as warning in docstring
Add clarification to Notes section Add clarification also as markup to serve as warning in docstring
…into improve_docstring_isreal
|
You have a long line that needs to be < 80 characters. |
@charris thanks for pointing out, fixed! |
charris
changed the title
numpy/lib/type_check.py
Outdated
| >>> np.isreal([None, False, "imaginary", complex]) | ||
| array([True, True, True, True]) |
There was a problem hiding this comment.
When tested, it returns False instead of an array in the following cases.
>>> np.isreal([2j, "a"])
/.../lib/python3.6/site-packages/numpy/lib/type_check.py:277: FutureWarning: elementwise comparison failed; returning scalar instead, but in the future will perform elementwise comparison
return imag(x) == 0
False
There was a problem hiding this comment.
That happens for string arrays, on current master, it should run into two future warnings, because the original input is already a mix of string and complex... Maybe fine to ignore.
There was a problem hiding this comment.
Maybe we should keep the Notes section as it is, and move the .. note:: directive down there with more details that the function does not work for string arrays, and for dtype=object currently always returns True even if the content is complex.
If we want an example, maybe include np.array([1+2j, ...], dtype=object) (a complex number and the dtype=object explicitly)?
There was a problem hiding this comment.
@cuspymd, @seberg, thanks for the comments. i've made fixes by moving the .. note:: directive down to the examples section as well as including the example for string array and mentioning that the function doesn't work, as well as the array with python objects returning all True even if it consists complex numbers. let me know if more clarifications can be added!
fix to docstring Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
improve note to explicitly warn about string or object arrays Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
remove note directive in examples section Co-authored-by: Ross Barnowski <rossbar@berkeley.edu>
|
CI failures are unrelated - the doctests in the circleci job are green and the rendered page looks good. |
|
thanks @rossbar ! can i merge it or is to be done by one of the maintainers? |
Add a clarification to docstring of
isrealmethod. Raised in #18814,isrealreturnsTruefor non-numeric inputs likeNone.Closes #18814