diff options
| author | kumudlakara <55556183+kumudlakara@users.noreply.github.com> | 2020-12-17 23:38:22 +0530 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-12-17 20:08:22 +0200 |
| commit | 5b63f260933672b7182daf4fb15ffcd15bae68bf (patch) | |
| tree | 8fc649a64571cb300f405c9930738bc078e47556 /numpy/lib/tests/test_utils.py | |
| parent | d714c8244011a01dfb6f6f453da132a9b10fd935 (diff) | |
| download | numpy-5b63f260933672b7182daf4fb15ffcd15bae68bf.tar.gz | |
DOC: Doc for deprecate_with_doc (#17852)
* Add doc for deprecate_with_doc
Co-authored-by: Bas van Beek <43369155+BvB93@users.noreply.github.com>
Co-authored-by: Matti Picus <matti.picus@gmail.com>
Diffstat (limited to 'numpy/lib/tests/test_utils.py')
| -rw-r--r-- | numpy/lib/tests/test_utils.py | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/numpy/lib/tests/test_utils.py b/numpy/lib/tests/test_utils.py index 33951b92a..8a877ae69 100644 --- a/numpy/lib/tests/test_utils.py +++ b/numpy/lib/tests/test_utils.py @@ -4,7 +4,7 @@ import pytest from numpy.core import arange from numpy.testing import assert_, assert_equal, assert_raises_regex -from numpy.lib import deprecate +from numpy.lib import deprecate, deprecate_with_doc import numpy.lib.utils as utils from io import StringIO @@ -60,6 +60,11 @@ def old_func6(self, x): new_func6 = deprecate(old_func6) +@deprecate_with_doc(msg="Rather use new_func7") +def old_func7(self,x): + return x + + def test_deprecate_decorator(): assert_('deprecated' in old_func.__doc__) @@ -73,6 +78,10 @@ def test_deprecate_fn(): assert_('new_func3' in new_func3.__doc__) +def test_deprecate_with_doc_decorator_message(): + assert_('Rather use new_func7' in old_func7.__doc__) + + @pytest.mark.skipif(sys.flags.optimize == 2, reason="-OO discards docstrings") @pytest.mark.parametrize('old_func, new_func', [ (old_func4, new_func4), |