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

incorrect parsing of numpy.ma.core:MaskedArray.resize docstring by numpydoc. #361

Open
Carreau opened this issue Dec 23, 2023 · 1 comment
Labels
parsing upstream Issues related to upstream projects

Comments

@Carreau
Copy link
Member

Carreau commented Dec 23, 2023

The docstring is:

.. warning::

    This method does nothing, except raise a ValueError exception. A
    masked array does not own its data and therefore cannot safely be
    resized in place. Use the `numpy.ma.resize` function instead.

This method is difficult to implement safely and may be deprecated in
future releases of NumPy.

This leads to a split of .. warning:: to be alone in its own section.

It does not seem to be critical for sphinx as it "reassemble" the "Summary" and "Extended summary", but maybe we can fix that upstream ?

@melissawm
Copy link
Collaborator

Exactly - that's what I detected earlier but forgot to flag. I think this should be fixed upstream. I am checking a list of potential fixes we could send to numpy in one go.

@melissawm melissawm added upstream Issues related to upstream projects parsing labels Dec 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
parsing upstream Issues related to upstream projects
Projects
None yet
Development

No branches or pull requests

2 participants