From: Sarah Hoffmann <lonvia@denofr.de>
Date: Thu, 7 Oct 2021 07:49:13 +0000 (+0200)
Subject: fix argument description for check_database
X-Git-Tag: v4.0.0~22^2~1
X-Git-Url: https://git.openstreetmap.org./nominatim.git/commitdiff_plain/2a94bfc703678eb1ee9aef55b3ae3610c9669aac?hp=-c

fix argument description for check_database
---

2a94bfc703678eb1ee9aef55b3ae3610c9669aac
diff --git a/nominatim/tokenizer/base.py b/nominatim/tokenizer/base.py
index 53289c78..02bc312f 100644
--- 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