Skip to content

Commit

Permalink
fixed typos in docs and code comments
Browse files Browse the repository at this point in the history
  • Loading branch information
biswajit-k committed Mar 3, 2023
1 parent c29b708 commit 6839eea
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions docs/customize/Import-Styles.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion nominatim/data/place_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ def country_code(self) -> Optional[str]:

@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
"""
Expand Down
2 changes: 1 addition & 1 deletion nominatim/data/place_name.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down
2 changes: 1 addition & 1 deletion nominatim/tokenizer/sanitizers/clean_postcodes.py
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ def scan(self, postcode: str, country: Optional[str]) -> Optional[Tuple[str, str


def create(config: SanitizerConfig) -> Callable[[ProcessInfo], None]:
""" Create a housenumber processing function.
""" Create function that filters postcodes by their officially allowed pattern
"""

return _PostcodeSanitizer(config)
2 changes: 1 addition & 1 deletion nominatim/tokenizer/sanitizers/clean_tiger_tags.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion nominatim/tokenizer/sanitizers/tag_analyzer_by_language.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
Arguments:
filter-kind: Restrict the names the sanitizer should be applied to
filter-kind: Restrict the names the sanitizer should be applied
to 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.
Expand Down

0 comments on commit 6839eea

Please sign in to comment.