mirror of
https://github.com/osm-search/Nominatim.git
synced 2024-09-11 19:17:17 +03:00
fixed typos in docs and code comments
This commit is contained in:
parent
8191c747b9
commit
36388cafe9
@ -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
|
Nominatim follows semantic versioning. Major releases are done for large changes
|
||||||
that require (or at least strongly recommend) a reimport of the databases.
|
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
|
contain bug fixes only and are released from a separate branch where the
|
||||||
relevant changes are cherry-picked from the master branch.
|
relevant changes are cherry-picked from the master branch.
|
||||||
|
|
||||||
|
@ -127,7 +127,7 @@ to the user when requested, but are not used otherwise.
|
|||||||
values. Tags with matching key/value pairs are deleted.
|
values. Tags with matching key/value pairs are deleted.
|
||||||
* __extra_keys__ is a _key match list_ for tags which should be saved into
|
* __extra_keys__ is a _key match list_ for tags which should be saved into
|
||||||
extratags
|
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.
|
values. Tags with matching key/value pairs are moved to extratags.
|
||||||
|
|
||||||
Key list may contain three kinds of strings:
|
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
|
`set_address_tags()` takes a table with arbitrary fields pointing to
|
||||||
_key match lists_. To fields have a special meaning:
|
_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
|
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
|
is usually the housenumber or variants thereof. If a main address tag
|
||||||
appears, then the object will always be included, if necessary with a
|
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:`
|
fallback of `place=house`. If the key has a prefix of `addr:` or `is_in:`
|
||||||
this will be stripped.
|
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
|
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
|
key match list, then its value will be added to the address tags with the
|
||||||
|
@ -55,7 +55,7 @@ class PlaceInfo:
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def rank_address(self) -> int:
|
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
|
[1]: ../customize/Ranking.md#address-rank
|
||||||
"""
|
"""
|
||||||
|
@ -21,7 +21,7 @@ class PlaceName:
|
|||||||
|
|
||||||
In addition to that, a name may have arbitrary additional attributes.
|
In addition to that, a name may have arbitrary additional attributes.
|
||||||
How attributes are used, depends on the sanitizers and token analysers.
|
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
|
which token analysis module will be used to finalize the treatment of
|
||||||
names.
|
names.
|
||||||
"""
|
"""
|
||||||
|
@ -74,7 +74,7 @@ class _PostcodeSanitizer:
|
|||||||
|
|
||||||
|
|
||||||
def create(config: SanitizerConfig) -> Callable[[ProcessInfo], None]:
|
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)
|
return _PostcodeSanitizer(config)
|
||||||
|
@ -41,6 +41,6 @@ def _clean_tiger_county(obj: ProcessInfo) -> None:
|
|||||||
|
|
||||||
|
|
||||||
def create(_: SanitizerConfig) -> Callable[[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
|
return _clean_tiger_county
|
||||||
|
@ -12,7 +12,7 @@ If a name already has an analyzer tagged, then this is kept.
|
|||||||
Arguments:
|
Arguments:
|
||||||
|
|
||||||
filter-kind: Restrict the names the sanitizer should be applied to
|
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'.
|
regular expressions which are matched against 'kind'.
|
||||||
Note that a match against the full string is expected.
|
Note that a match against the full string is expected.
|
||||||
whitelist: Restrict the set of languages that should be tagged.
|
whitelist: Restrict the set of languages that should be tagged.
|
||||||
|
Loading…
Reference in New Issue
Block a user