]> git.openstreetmap.org Git - nominatim.git/commitdiff
fixed typos in docs and code comments
authorbiswajit-k <biswajitkaushik02@gmail.com>
Mon, 6 Mar 2023 11:39:38 +0000 (17:09 +0530)
committerbiswajit-k <biswajitkaushik02@gmail.com>
Mon, 6 Mar 2023 11:39:38 +0000 (17:09 +0530)
CONTRIBUTING.md
docs/customize/Import-Styles.md
nominatim/data/place_info.py
nominatim/data/place_name.py
nominatim/tokenizer/sanitizers/clean_postcodes.py
nominatim/tokenizer/sanitizers/clean_tiger_tags.py
nominatim/tokenizer/sanitizers/tag_analyzer_by_language.py

index 6d75ce57f1e3a7acf8f36569015d9a69ad8e4c03..8baadb28e4d63bf31ef3230e4ec25a0686026f68 100644 (file)
@@ -69,7 +69,7 @@ Before submitting a pull request make sure that the tests pass:
 
 Nominatim follows semantic versioning. Major releases are done for large changes
 that require (or at least strongly recommend) a reimport of the databases.
-Minor releases can usually be applied to exisiting databases Patch releases
+Minor releases can usually be applied to exisiting databases. Patch releases
 contain bug fixes only and are released from a separate branch where the
 relevant changes are cherry-picked from the master branch.
 
index 6085d4e473f0efb4944d2a5eac9c0316f79da733..e96f96e039baaacbf99c7316f698a2a05708430a 100644 (file)
@@ -127,7 +127,7 @@ to the user when requested, but are not used otherwise.
   values. Tags with matching key/value pairs are deleted.
 * __extra_keys__ is a _key match list_ for tags which should be saved into
   extratags
-* __delete_tags__ contains a table of tag keys pointing to a list of tag
+* __extra_tags__ contains a table of tag keys pointing to a list of tag
   values. Tags with matching key/value pairs are moved to extratags.
 
 Key list may contain three kinds of strings:
@@ -193,14 +193,14 @@ Address tags will be used to build up the address of an object.
 `set_address_tags()` takes a table with arbitrary fields pointing to
 _key match lists_. To fields have a special meaning:
 
-__main__ defines
+* __main__: defines
 the tags that make a full address object out of the OSM object. This
 is usually the housenumber or variants thereof. If a main address tag
 appears, then the object will always be included, if necessary with a
 fallback of `place=house`. If the key has a prefix of `addr:` or `is_in:`
 this will be stripped.
 
-__extra__ defines all supplementary tags for addresses, tags like `addr:street`, `addr:city` etc. If the key has a prefix of `addr:` or `is_in:` this will be stripped.
+* __extra__: defines all supplementary tags for addresses, tags like `addr:street`, `addr:city` etc. If the key has a prefix of `addr:` or `is_in:` this will be stripped.
 
 All other fields will be handled as summary fields. If a key matches the
 key match list, then its value will be added to the address tags with the
index 1bfd512c38e169e318373ff61a04aab3cd122f4f..91e77a588514ca4c2cd457d95286ca49883dd7e0 100644 (file)
@@ -55,7 +55,7 @@ class PlaceInfo:
 
     @property
     def rank_address(self) -> int:
-        """ The [rank address][1] before ant rank correction is applied.
+        """ The [rank address][1] before any rank correction is applied.
 
             [1]: ../customize/Ranking.md#address-rank
         """
index f4c5e0fa30d21b3fb4bfa7e70eb5cf18f90ae7b4..47464e2b323b4c753f7e58e2c433e77dec57ea59 100644 (file)
@@ -21,7 +21,7 @@ class PlaceName:
 
         In addition to that, a name may have arbitrary additional attributes.
         How attributes are used, depends on the sanitizers and token analysers.
-        The exception is is the 'analyzer' attribute. This attribute determines
+        The exception is the 'analyzer' attribute. This attribute determines
         which token analysis module will be used to finalize the treatment of
         names.
     """
index 593f770db9ade7b1e9d8915d6de85d19003d63b5..5eaea3917c7aea9a2e8047f773cd03ac17990d34 100644 (file)
@@ -74,7 +74,7 @@ class _PostcodeSanitizer:
 
 
 def create(config: SanitizerConfig) -> Callable[[ProcessInfo], None]:
-    """ Create a housenumber processing function.
+    """ Create a function that filters postcodes by their officially allowed pattern.
     """
 
     return _PostcodeSanitizer(config)
index 9698a326a9fe2157d2bb7ca237e57ebb8d79846c..8b4d337d5f8b68c1db6c082e08e5330f18185d22 100644 (file)
@@ -41,6 +41,6 @@ def _clean_tiger_county(obj: ProcessInfo) -> None:
 
 
 def create(_: SanitizerConfig) -> Callable[[ProcessInfo], None]:
-    """ Create a housenumber processing function.
+    """ Create a function that preprocesses tags from the TIGER import.
     """
     return _clean_tiger_county
index 6d6430f034e0c10dfae13555e137b40ccae19484..032b69a8cb6c07dd67e673351e6810bbd334cbf9 100644 (file)
@@ -12,7 +12,7 @@ If a name already has an analyzer tagged, then this is kept.
 Arguments:
 
     filter-kind: Restrict the names the sanitizer should be applied to
-                 to the given tags. The parameter expects a list of
+                 the given tags. The parameter expects a list of
                  regular expressions which are matched against 'kind'.
                  Note that a match against the full string is expected.
     whitelist: Restrict the set of languages that should be tagged.