From 36388cafe9709bff3153096690c3f88175084ee0 Mon Sep 17 00:00:00 2001 From: biswajit-k Date: Mon, 6 Mar 2023 17:09:38 +0530 Subject: [PATCH] fixed typos in docs and code comments --- CONTRIBUTING.md | 2 +- docs/customize/Import-Styles.md | 6 +++--- nominatim/data/place_info.py | 2 +- nominatim/data/place_name.py | 2 +- nominatim/tokenizer/sanitizers/clean_postcodes.py | 2 +- nominatim/tokenizer/sanitizers/clean_tiger_tags.py | 2 +- nominatim/tokenizer/sanitizers/tag_analyzer_by_language.py | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d75ce57..8baadb28 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/docs/customize/Import-Styles.md b/docs/customize/Import-Styles.md index 6085d4e4..e96f96e0 100644 --- a/docs/customize/Import-Styles.md +++ b/docs/customize/Import-Styles.md @@ -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 diff --git a/nominatim/data/place_info.py b/nominatim/data/place_info.py index 1bfd512c..91e77a58 100644 --- a/nominatim/data/place_info.py +++ b/nominatim/data/place_info.py @@ -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 """ diff --git a/nominatim/data/place_name.py b/nominatim/data/place_name.py index f4c5e0fa..47464e2b 100644 --- a/nominatim/data/place_name.py +++ b/nominatim/data/place_name.py @@ -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. """ diff --git a/nominatim/tokenizer/sanitizers/clean_postcodes.py b/nominatim/tokenizer/sanitizers/clean_postcodes.py index 593f770d..5eaea391 100644 --- a/nominatim/tokenizer/sanitizers/clean_postcodes.py +++ b/nominatim/tokenizer/sanitizers/clean_postcodes.py @@ -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) diff --git a/nominatim/tokenizer/sanitizers/clean_tiger_tags.py b/nominatim/tokenizer/sanitizers/clean_tiger_tags.py index 9698a326..8b4d337d 100644 --- a/nominatim/tokenizer/sanitizers/clean_tiger_tags.py +++ b/nominatim/tokenizer/sanitizers/clean_tiger_tags.py @@ -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 diff --git a/nominatim/tokenizer/sanitizers/tag_analyzer_by_language.py b/nominatim/tokenizer/sanitizers/tag_analyzer_by_language.py index 6d6430f0..032b69a8 100644 --- a/nominatim/tokenizer/sanitizers/tag_analyzer_by_language.py +++ b/nominatim/tokenizer/sanitizers/tag_analyzer_by_language.py @@ -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.