-
-
Notifications
You must be signed in to change notification settings - Fork 10.9k
DOC: mark np.testing.dec functions as not recommended for future use #17566
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
Comments
Going to take a stab at this. |
From what it looks like the docstrings from submodules don't actually get pulled in anywhere. Should I just deprecate the entire np.testing module, since it looks mostly nose based? Or is there some other way I should document submodules of np.testing? |
The rendered documentation does included the public functions from that module. that.This issue is about deprecating only the |
Ah, I see. So put it on the individual functions then? |
The original ask was just to add a blurb in the docstring of the module to discourage the use of these functions. Deprecation warnings will be noisy, since the warning will be emitted during test collection. If you want to add the deprecations, please follow the pattern of
and make sure tests pass cleanly. The relevant tests of the deprecated functions should move to |
Now that the decorators are deprected we need to update the docs at https://numpy.org/devdocs/reference/routines.testing.html#decorators to make this clear. |
Closing as the warnings are visible now. |
Uh oh!
There was an error while loading. Please reload this page.
Given that
I think we should update the docs at https://numpy.org/devdocs/reference/routines.testing.html#decorators to make this clear.
We might also want to consider deprecating them fully with
DeprecationWarning
sThe text was updated successfully, but these errors were encountered: