Improve the warning message for old_style error capturing deprecation.

numba · Aug 22, 2023 · 8d04ce8 · 8d04ce8 · seanlaw · Aug 27, 2023
1 parent da49bf3
commit 8d04ce8
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 7 deletions.
diff --git a/numba/core/utils.py b/numba/core/utils.py
@@ -192,17 +192,21 @@ def shutting_down(globals=globals):
 atexit.register(_at_shutdown)
 
 
+_old_style_deprecation_msg = (
+"Code using Numba extension API maybe depending on 'old_style' error-capturing,"
+" which is deprecated and will be replaced by 'new_style' in a future release."
+" See details at https://numba.readthedocs.io/en/latest/reference/deprecation.html#deprecation-of-old-style-numba-captured-errors" # noqa: E501
+)
+
+
 def _warn_old_style():
     from numba.core import errors  # to prevent circular import
 
     exccls, _, _ = sys.exc_info()
     # Warn only if the active exception is not a NumbaError
     if exccls is not None and not issubclass(exccls, errors.NumbaError):
-        warnings.warn(
-            "The 'old_style' error capturing is deprecated "
-            "and will be replaced by `new_style` in a future release.",
-            errors.NumbaPendingDeprecationWarning,
-        )
+        warnings.warn(_old_style_deprecation_msg,
+                      errors.NumbaPendingDeprecationWarning)
 
 
 def use_new_style_errors():

diff --git a/numba/tests/test_errorhandling.py b/numba/tests/test_errorhandling.py
@@ -493,8 +493,11 @@ def ol_bar(x):
                 def foo(x):
                     bar(x)
 
-            self.assertIn("The 'old_style' error capturing is deprecated",
-                          str(warns.warnings[0].message))
+            self.assertIn(
+                "Code using Numba extension API maybe depending on 'old_style' "
+                "error-capturing",
+                str(warns.warnings[0].message),
+            )
 
     @TestCase.run_test_in_subprocess(
         envvars={"NUMBA_CAPTURED_ERRORS": "old_style"},