DOC: Restore MaskedArray.hardmask documentation #20810
Merged
Conversation
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
This documentation got completely lost when switching to :autoattribute: in 2f41bb2; all remaining documentation made circular references to other aspects of hard vs. soft, without any explanation of what this means.
The API is a little unusual here; IMO a more pythonic behavior would've been not to return self, because self is already modified (cf. `ndarray.sort()`, for instance). But at least I wanted to make this behavior a little more clear in the documentation.
|
(I just force-pushed an update fixing lines that were a single character too long.) |
|
Thanks @hmeine ! Would it be too much trouble to add an example, showing unmasking by assignment in the soft case and a hard mask preventing that? Other than that, LGTM :) |
|
Yes, I had already prepared one, anyhow, and just had to find out how to properly include it in the docstring. In fact, I still don't know how to make the linter happy; wouldn't the doctests fail if I manually wrapped the output from the python interpreter (line 3616)? |
|
This looks good, thanks @hmeine ! |
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.
Fix #19331 by properly documenting the purpose of MaskedArray.hardmask