summaryrefslogtreecommitdiff
path: root/numpy/testing/_private/utils.py
diff options
context:
space:
mode:
authorSeth Troisi <sethtroisi@google.com>2020-05-28 19:59:07 -0700
committerSeth Troisi <sethtroisi@google.com>2020-05-28 19:59:07 -0700
commit4f09c90b8297b765e71ff816856aca7ee2405c6b (patch)
treeb7c496ef15deac0bcbfd8d7dd445ff0a7c1e204d /numpy/testing/_private/utils.py
parentba4e4b6558050e0ef0fa3a312a46d65a5f021c16 (diff)
downloadnumpy-4f09c90b8297b765e71ff816856aca7ee2405c6b.tar.gz
DOC: Update assert_warns parameter list
Diffstat (limited to 'numpy/testing/_private/utils.py')
-rw-r--r--numpy/testing/_private/utils.py8
1 files changed, 3 insertions, 5 deletions
diff --git a/numpy/testing/_private/utils.py b/numpy/testing/_private/utils.py
index 4097a6738..f8789af90 100644
--- a/numpy/testing/_private/utils.py
+++ b/numpy/testing/_private/utils.py
@@ -1768,12 +1768,10 @@ def assert_warns(warning_class, *args, **kwargs):
----------
warning_class : class
The class defining the warning that `func` is expected to throw.
- func : callable
- The callable to test.
- \\*args : Arguments
- Arguments passed to `func`.
+ \\*args : List of function and arguments
+ `func` and arguments for `func`.
\\*\\*kwargs : Kwargs
- Keyword arguments passed to `func`.
+ Keyword arguments for `func`.
Returns
-------