Skip to content

API: Readd add_docstring and add_newdoc to np.lib #24564

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

Merged
merged 1 commit into from
Aug 28, 2023

Conversation

mtsokol
Copy link
Member

@mtsokol mtsokol commented Aug 28, 2023

Relevant issue #24507

Hi @rgommers,

Reverts a change introduced in #24538.
As agreed in the main namespace design, add_docstring and add_newdoc should stay in np.lib and be available only from that namespace. These two were unnecessarily removed from there in #24538. (np.lib namespace refactor PR is still TBD, but this needs to be merged to fix SciPy builds)

@mtsokol mtsokol force-pushed the revert-add-newdoc branch from 97df2d8 to 6658e74 Compare August 28, 2023 07:55
Copy link
Member

@rgommers rgommers left a comment

Choose a reason for hiding this comment

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

Thanks for the quick fix @mtsokol. These removals from numpy.lib were unintentional, so in this goes. We can revisit the rest later. add_docstring looks more questionable and is used less than add_newdoc, so I expect we'd clean up at least that one later on.

@rgommers rgommers merged commit ef0fd39 into numpy:main Aug 28, 2023
@mtsokol mtsokol deleted the revert-add-newdoc branch August 28, 2023 08:33
@WarrenWeckesser
Copy link
Member

Thanks @mtsokol!

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

Successfully merging this pull request may close these issues.

3 participants