zaclys
/
searxng
mirror of https://github.com/searxng/searxng.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

[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>
This commit is contained in:
Markus Heiser 2021-06-09 15:16:59 +02:00
parent 5c5db719d2
commit ab259017cc
1 changed files with 2 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/dev/engine_overview.rst
View File

@ -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: