-
-
Notifications
You must be signed in to change notification settings - Fork 11.1k
DOC: Document ma.filled behavior with non-scalar fill_value #13698
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
I think examples would be nice. We should also standardize the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure we want to document this, as remarked in the other issues you xref
We should implement the deprecation warning as in #13421, and add the examples from there. |
The test I have commented out is the one which fails due to |
@seberg when I added a check like
at the end of the |
"arrays with scalar values instead. The filled function " | ||
"still supports any array as `fill_value`.", | ||
DeprecationWarning, stacklevel=2) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs a date and version comment so we know when we can turn the deprecation into an error
Release note needed for the new deprecation |
This looks almost ready, just need to add a 1.18.0 version number to the deprecation, and a release note. |
Actually, we deprecate non-scalar or matching fills as it is there, should check what we want to do.
Thanks @kritisingh1 |
Closes #4363
xref #13241 #10504
@mattip for now, I have just documented the behavior with non-scalar fill values. The PRs xref'ed above talked about deprecating the non-scalar nature(optional) of fill value. Do we really need to deprecate if we are already mentioning that, that behavior is not supported and throwing a meaningful error?
Also, should I include examples of what fill_values with input array combination could be risky?