Documentation

qgis · Jun 5, 2018 · 4e38d06 · 4e38d06
1 parent 40a2062
commit 4e38d06
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/python/utils.py b/python/utils.py
@@ -195,8 +195,12 @@ def qgis_excepthook(type, value, tb):
 
 def installErrorHook():
     """
-    Installs the QGIS application error/warning hook
+    Installs the QGIS application error/warning hook. This causes Python exceptions
-    :return:
+    to be intercepted by the QGIS application and shown in the main window message bar
+    and in custom dialogs.
+
+    Generally you shouldn't call this method - it's automatically called by
+    the QGIS app on startup, and has no use in standalone applications and scripts.
     """
     sys.excepthook = qgis_excepthook
     warnings.showwarning = showWarning