mirror of https://github.com/searxng/searxng.git
[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>
This commit is contained in:
parent
b3708e4137
commit
fbf07237ff
|
@ -81,6 +81,7 @@ engine_shortcuts = {}
|
|||
|
||||
engine_shortcuts[engine.shortcut] = engine.name
|
||||
|
||||
:meta hide-value:
|
||||
"""
|
||||
|
||||
|
||||
|
|
|
@ -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
|
||||
|
|
Loading…
Reference in New Issue