summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2021-06-09 15:16:59 +0200
committerMarkus Heiser <markus.heiser@darmarit.de>2021-06-09 15:16:59 +0200
commitab259017cc52935cf862dd2f30f961a8f7fb5b2b (patch)
tree3a91841df74842c404375ed661450da826771d37 /docs
parent5c5db719d2039d34aa1426bf7eb3e57055d4a54a (diff)
downloadsearxng-ab259017cc52935cf862dd2f30f961a8f7fb5b2b.tar.gz
searxng-ab259017cc52935cf862dd2f30f961a8f7fb5b2b.zip
[fix] section "Overrides" in engine's documentation
[1] https://github.com/searxng/searxng/pull/97#discussion_r646094256 Suggested-by: @dalf [1] Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/engine_overview.rst8
1 files changed, 2 insertions, 6 deletions
diff --git a/docs/dev/engine_overview.rst b/docs/dev/engine_overview.rst
index d79f662b8..8049325cf 100644
--- a/docs/dev/engine_overview.rst
+++ b/docs/dev/engine_overview.rst
@@ -85,15 +85,11 @@ For a more detailed description, see :ref:`settings engine` in the :ref:`settin
Overrides
---------
-.. sidebar:: engine's global names
-
- Global names with a leading underline are *private to the engine* and will
- not be overwritten.
-
A few of the options have default values in the namespace of engine's python
modul, but are often overwritten by the settings. If ``None`` is assigned to an
option in the engine file, it has to be redefined in the settings, otherwise
-searx will not start with that engine.
+searx will not start with that engine (global names with a leading underline can
+be ``None``).
Here is an very simple example of the global names in the namespace of engine's
module: