diff options
| author | Markus Heiser <markus.heiser@darmarit.de> | 2022-09-18 12:44:12 +0200 |
|---|---|---|
| committer | Markus Heiser <markus.heiser@darmarit.de> | 2022-09-18 12:44:12 +0200 |
| commit | fbf07237ff18e3d5e3d0a32bbc20307c3cc8d9af (patch) | |
| tree | 47c7ca834945a4647e7b0403c4bfc14966a9f924 /searx | |
| parent | b3708e4137cf66c7f2966e811c2fae907c28089a (diff) | |
| download | searxng-fbf07237ff18e3d5e3d0a32bbc20307c3cc8d9af.tar.gz searxng-fbf07237ff18e3d5e3d0a32bbc20307c3cc8d9af.zip | |
[fix] and improve docs generated from source code.
Fix::
searx/locales.py:docstring of searx.locales.get_engine_locale:17: \
WARNING: Definition list ends without a blank line; unexpected unindent.
Improvement: don't show default values in the generated documentation whe it is
more a mess than a usefull information (`:meta hide-value:`).
Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'searx')
| -rw-r--r-- | searx/engines/__init__.py | 1 | ||||
| -rw-r--r-- | searx/locales.py | 7 |
2 files changed, 6 insertions, 2 deletions
diff --git a/searx/engines/__init__.py b/searx/engines/__init__.py index 07d5b226c..57b090add 100644 --- a/searx/engines/__init__.py +++ b/searx/engines/__init__.py @@ -81,6 +81,7 @@ engine_shortcuts = {} engine_shortcuts[engine.shortcut] = engine.name +:meta hide-value: """ diff --git a/searx/locales.py b/searx/locales.py index 0e57c91b0..620132340 100644 --- a/searx/locales.py +++ b/searx/locales.py @@ -25,7 +25,10 @@ _flask_babel_get_translations = flask_babel.get_translations LOCALE_NAMES = {} """Mapping of locales and their description. Locales e.g. 'fr' or 'pt-BR' (see -:py:obj:`locales_initialize`).""" +:py:obj:`locales_initialize`). + +:meta hide-value: +""" RTL_LOCALES: Set[str] = set() """List of *Right-To-Left* locales e.g. 'he' or 'fa-IR' (see @@ -159,7 +162,7 @@ def get_engine_locale(searxng_locale, engine_locales, default=None): ``searxng_locale``. Argument ``engine_locales`` is a python dict that maps *SearXNG locales* to - corresponding *engine locales*: + corresponding *engine locales*:: <engine>: { # SearXNG string : engine-string |