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

[doc] fix some minor typos in the doc-strings of class EngineTraits 

Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
This commit is contained in:
Markus Heiser 2023-08-08 08:06:22 +02:00 committed by Markus Heiser
parent a2108432f7
commit bcaaae699f
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
searx/enginelib/traits.py
View File

@ -95,8 +95,8 @@ class EngineTraits:
:param default: engine's default language :param default: engine's default language
The *best fits* rules are implemented in The *best fits* rules are implemented in
:py:obj:`locales.get_engine_locale`. Except for the special value ``all`` :py:obj:`searx.locales.get_engine_locale`. Except for the special value ``all``
which is determined from :py:obj`EngineTraits.all_language`. which is determined from :py:obj:`EngineTraits.all_locale`.
""" """
if searxng_locale == 'all' and self.all_locale is not None: if searxng_locale == 'all' and self.all_locale is not None:
return self.all_locale return self.all_locale
@ -111,18 +111,20 @@ class EngineTraits:
:param default: engine's default region :param default: engine's default region
The *best fits* rules are implemented in The *best fits* rules are implemented in
:py:obj:`locales.get_engine_locale`. Except for the special value ``all`` :py:obj:`searx.locales.get_engine_locale`. Except for the special value ``all``
which is determined from :py:obj`EngineTraits.all_language`. which is determined from :py:obj:`EngineTraits.all_locale`.
""" """
if searxng_locale == 'all' and self.all_locale is not None: if searxng_locale == 'all' and self.all_locale is not None:
return self.all_locale return self.all_locale
return locales.get_engine_locale(searxng_locale, self.regions, default=default) return locales.get_engine_locale(searxng_locale, self.regions, default=default)
def is_locale_supported(self, searxng_locale: str) -> bool: def is_locale_supported(self, searxng_locale: str) -> bool:
"""A *locale* (SearXNG's internal representation) is considered to be supported """A *locale* (SearXNG's internal representation) is considered to be
by the engine if the *region* or the *language* is supported by the supported by the engine if the *region* or the *language* is supported
engine. For verification the functions :py:func:`self.get_region` and by the engine.
:py:func:`self.get_region` are used.
For verification the functions :py:func:`EngineTraits.get_region` and
:py:func:`EngineTraits.get_language` are used.
""" """
if self.data_type == 'traits_v1': if self.data_type == 'traits_v1':
return bool(self.get_region(searxng_locale) or self.get_language(searxng_locale)) return bool(self.get_region(searxng_locale) or self.get_language(searxng_locale))