summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAngéllica Araujo <angellica.c.a@gmail.com>2022-06-01 08:54:47 -0300
committerGitHub <noreply@github.com>2022-06-01 08:54:47 -0300
commitb84d4d04fc91a7b793aafd4b3641af9796d3062c (patch)
treee8a2588f56a17bafd11680485fa917e8d76660b8
parentc8de16e440e778f4659671422ae78a6cdf7bf089 (diff)
downloadnumpy-b84d4d04fc91a7b793aafd4b3641af9796d3062c.tar.gz
DOC: adding docstring to TooHardError class (#21471)
-rw-r--r--numpy/core/_exceptions.py9
1 files changed, 9 insertions, 0 deletions
diff --git a/numpy/core/_exceptions.py b/numpy/core/_exceptions.py
index 3cd8042ce..be3aa8bee 100644
--- a/numpy/core/_exceptions.py
+++ b/numpy/core/_exceptions.py
@@ -117,6 +117,15 @@ class _UFuncOutputCastingError(_UFuncCastingError):
# Exception used in shares_memory()
@set_module('numpy')
class TooHardError(RuntimeError):
+ """max_work was exceeded.
+
+ This is raised whenever the maximum number of candidate solutions
+ to consider specified by the ``max_work`` parameter is exceeded.
+ Assigning a finite number to max_work may have caused the operation
+ to fail.
+
+ """
+
pass