IPython console: Improve docstring of SpyderKernelError

procitec · Dec 12, 2024 · 868cbc8 · 868cbc8
1 parent c99d044
commit 868cbc8
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/spyder/plugins/ipythonconsole/__init__.py b/spyder/plugins/ipythonconsole/__init__.py
@@ -44,5 +44,12 @@
 
 
 class SpyderKernelError(RuntimeError):
-    """Error to be shown in client."""
-    pass
+    """
+    Error to be shown in the IPython console.
+
+    Notes
+    -----
+    * Use this exception if you want to show a nice formatted error in the
+      current console instead of a long and hard-to-read traceback.
+    * This should only be used for errors whose cause we are certain of.
+    """