-
Notifications
You must be signed in to change notification settings - Fork 21
docs: extend masking docs with examples #3738
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
docs/user-guide/masking.ipynb
Outdated
| "metadata": {}, | ||
| "source": [ | ||
| "In the example above the mask was specified as the data array was created.\n", | ||
| "But like for `coords` masks can also be assigned after the data array was created:" |
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.
[Minor]
| "But like for `coords` masks can also be assigned after the data array was created:" | |
| "However, similar to `coords`, `masks` can also be assigned on an existing `DataArray` instance:" |
Sth like this maybe...?
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.
Yeah that's better, I'll update and reword it similar to that
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 am not sure we can assign to masks? I suppose you mean setting items?
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.
But the interface is called assign_masks though...?
You mean it's not possble on the same instance?
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.
assign_masks return a new object, yes. Also, the example right after this text sets a mask. It is not assigning the masks property.
Co-authored-by: Sunyoung Yoo <17974113+YooSunYoung@users.noreply.github.com>
9cc549c to
7e1ba6c
Compare
|
@scipp/scipp-maintainers |
Fixes #3699