Skip to content
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

Improve documentation of numpy.ma.filled #26481

Merged
merged 2 commits into from
May 30, 2024

Conversation

karthikkaiplody
Copy link
Contributor

Closes #9716

numpy/ma/core.py Outdated
Return input as an array with masked data replaced by a fill value.
Return a copy of `a`, with masked values replaced by a fill value.
However, if there are no masked values to fill, `a` will be returned
instead as an ndarray.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it "a's data will be returned" or "a copy of a will be returned"?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also note that this information shouldn't be part of the initial sentence, but rather the following paragraph.

@karthikkaiplody karthikkaiplody changed the title Imporve documentation of numpy.ma.filled Improve documentation of numpy.ma.filled May 20, 2024
Copy link
Contributor

@rossbar rossbar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since they were minor changes, I took the liberty of incorporating the review feedback and pushing up the tweaks.

[skip azp] [skip actions] [skip cirrus]
@mattip mattip merged commit f2c93e2 into numpy:main May 30, 2024
4 checks passed
@mattip
Copy link
Member

mattip commented May 30, 2024

Thanks @karthikkaiplody, @rossbar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Potential Copy Pitfall in numpy.ma.filled
4 participants