From 0b27c8698f7b5bbca5083cf234fabbc7d7308349 Mon Sep 17 00:00:00 2001
From: Alexandre Flament <alex@al-f.net>
Date: Thu, 9 Sep 2021 11:23:57 +0200
Subject: [doc] update docs/dev/plugins.rst

---
 searx/search/__init__.py | 10 +++++-----
 searx/search/models.py   |  1 +
 2 files changed, 6 insertions(+), 5 deletions(-)

(limited to 'searx')

diff --git a/searx/search/__init__.py b/searx/search/__init__.py
index 6c750a3f9..69d7ffb25 100644
--- a/searx/search/__init__.py
+++ b/searx/search/__init__.py
@@ -39,7 +39,7 @@ class Search:
 
     __slots__ = "search_query", "result_container", "start_time", "actual_timeout"
 
-    def __init__(self, search_query):
+    def __init__(self, search_query: SearchQuery):
         # init vars
         super().__init__()
         self.search_query = search_query
@@ -163,7 +163,7 @@ class Search:
         return True
 
     # do search-request
-    def search(self):
+    def search(self) -> ResultContainer:
         self.start_time = default_timer()
         if not self.search_external_bang():
             if not self.search_answerers():
@@ -172,11 +172,11 @@ class Search:
 
 
 class SearchWithPlugins(Search):
-    """Similar to the Search class but call the plugins."""
+    """Inherit from the Search class, add calls to the plugins."""
 
     __slots__ = 'ordered_plugin_list', 'request'
 
-    def __init__(self, search_query, ordered_plugin_list, request):
+    def __init__(self, search_query: SearchQuery, ordered_plugin_list, request: "flask.Request"):
         super().__init__(search_query)
         self.ordered_plugin_list = ordered_plugin_list
         self.result_container.on_result = self._on_result
@@ -192,7 +192,7 @@ class SearchWithPlugins(Search):
     def _on_result(self, result):
         return plugins.call(self.ordered_plugin_list, 'on_result', self.request, self, result)
 
-    def search(self):
+    def search(self) -> ResultContainer:
         if plugins.call(self.ordered_plugin_list, 'pre_search', self.request, self):
             super().search()
 
diff --git a/searx/search/models.py b/searx/search/models.py
index 7233fac42..e48cb3611 100644
--- a/searx/search/models.py
+++ b/searx/search/models.py
@@ -4,6 +4,7 @@ import typing
 
 
 class EngineRef:
+    """Reference by names to an engine and category"""
 
     __slots__ = 'name', 'category'
 
-- 
cgit v1.2.3