DOC: Clarify docstring of masked_equal and masked_values
#22436
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
charris
reviewed
Oct 18, 2022
numpy/ma/core.py
Outdated
| @@ -2085,6 +2085,8 @@ def masked_equal(x, value, copy=True): | |||
| `condition` = (x == value). For floating point arrays, | |||
| consider using ``masked_values(x, value)``. | |||
|
|
|||
| The fill_value is set to `value`. | |||
There was a problem hiding this comment.
This isolated paragraph/sentence doesn't make sense. Could you try rewriting the whole thing together with the previous paragraph?
There was a problem hiding this comment.
Hope it is more explicit now.
|
Hello, this is supposed to fix a very old issue... I'm a closember fan... :) |
seberg
reviewed
Nov 21, 2022
|
OK, doc test was successful and it LGTM now. Thanks. |
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.
This pull request clarifies the documentation of the functions
masked_equalandmasked_values.It is supposed to fix #5408.
With respect to the issue description, the example of
masked_equalwas already modified to be consistent with the implementation.fill_valueformasked_equalmasked_valuesto clarify its difference with respect tomasked_equal(as the homogenization of thefill_valueimplementation made this difference less explicit, ...in my opinion,... :) )Thanks for considering this PR.