summaryrefslogtreecommitdiff
path: root/docs/admin/settings.rst
diff options
context:
space:
mode:
authorNoémi Ványi <sitbackandwait@gmail.com>2020-03-29 13:14:06 +0200
committerNoémi Ványi <sitbackandwait@gmail.com>2020-05-31 19:17:48 +0200
commite3282748d0433d455336487f7e36b789fe6ade30 (patch)
tree521fbd7806bf636bdf09c5e2f9be4d4fa2493e8d /docs/admin/settings.rst
parentd38952c1335d3c6f8615870b11ef9737b203ad49 (diff)
add display_error_messages option to engine settings
A new option is added to engines to hide error messages from users. It is called `display_error_messages` and by default it is set to `True`. If it is set to `False` error messages do not show up on the UI. Keep in mind that engines are still suspended if needed regardless of this setting. Closes #1828
Diffstat (limited to 'docs/admin/settings.rst')
-rw-r--r--docs/admin/settings.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/admin/settings.rst b/docs/admin/settings.rst
index 2c42a21e9..2bfbae35c 100644
--- a/docs/admin/settings.rst
+++ b/docs/admin/settings.rst
@@ -175,6 +175,9 @@ Engine settings
``weigth`` : default ``1``
Weighting of the results of this engine.
+``display_error_messages`` : default ``True``
+ When an engine returns an error, the message is displayed on the user interface.
+
.. note::
A few more options are possible, but they are pretty specific to some