add documentation for new configuration of ICU tokenizer

[nominatim.git] / nominatim / tokenizer / base.py

diff --git a/nominatim/tokenizer/base.py b/nominatim/tokenizer/base.py
index 53289c7816e9a32ca671c2205d35f19b217d5d68..02bc312f18dc5e0bbe65fcacfc7e3564f805d441 100644 (file)
--- a/nominatim/tokenizer/base.py
+++ b/nominatim/tokenizer/base.py
@@ -194,15 +194,13 @@ class AbstractTokenizer(ABC):
         """ Check that the database is set up correctly and ready for being
             queried.
 
-            Returns:
-              If an issue was found, return an error message with the
-              description of the issue as well as hints for the user on
-              how to resolve the issue.
-
             Arguments:
               config: Read-only object with configuration options.
 
-              Return `None`, if no issue was found.
+            Returns:
+              If an issue was found, return an error message with the
+              description of the issue as well as hints for the user on
+              how to resolve the issue. If everything is okay, return `None`.
         """
         pass