Repository navigation
DOC: cross-reference np.ma.correlate from np.ma.convolve for propagate_mask - #31852
Merged
mattip merged 2 commits intoJul 6, 2026
Merged
Conversation
Member
|
I am not sure we want to bloat the documentation with examples for each use of propogate_mask. Maybe it would be better to add |
shoumikchakravarty-dev
changed the title
Member
|
Unfortunately you did not use |
Contributor
Author
|
@mattip - Thanks. I have dropped the example and instead added the cross reference to |
Member
|
Thanks @shoumikchakravarty-dev |
MaanasArora
pushed a commit
to MaanasArora/numpy
that referenced
this pull request
Jul 7, 2026
This was referenced Jul 8, 2026
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
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.
PR summary
This is an improvement PR. I have added an Examples section to the documentation for np.ma.convolve showing the propagate_mask behavior (mirroring the existing examples on its sibling np.ma.correlate). Doc-only; doctest-verified locally.
First time committer introduction
No. Previous Contribution #31802
AI Disclosure
An AI assistant (Anthropic's Claude, via the Claude desktop app) was used to locate a public function whose docstring lacked an Examples section, draft the example, and verify it passes as a doctest. I reviewed and understand each line; the change is documentation-only- a new Examples section added to np.ma.convolve. This PR summary and introduction were written by me.