split code into submodules

[nominatim.git] / docs / api / Search.md

diff --git a/docs/api/Search.md b/docs/api/Search.md
index 3f9d9fc7d881bd827df95f0641f6f6608d91c5a5..ab3c8444c9d0c7f7d463c5a1844b12b332d2f2eb 100644 (file)
--- a/docs/api/Search.md
+++ b/docs/api/Search.md
@@ -165,7 +165,7 @@ results and thus give a preference to some results over others.
 |-----------| ----- | ------- |
 | countrycodes | comma-separated list of country codes | _unset_ |
 
 |-----------| ----- | ------- |
 | countrycodes | comma-separated list of country codes | _unset_ |
 

-Filer that limits the search results to one or more countries.
+Filter that limits the search results to one or more countries.

 The country code must be the
 [ISO 3166-1alpha2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code
 of the country, e.g. `gb` for the United Kingdom, `de` for Germany.
 The country code must be the
 [ISO 3166-1alpha2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code
 of the country, e.g. `gb` for the United Kingdom, `de` for Germany.


@@ -179,7 +179,7 @@ also excluded when the filter is set.
     This parameter should not be confused with the 'country' parameter of
     the structured query. The 'country' parameter contains a search term
     and will be handled with some fuzziness. The `countrycodes` parameter
     This parameter should not be confused with the 'country' parameter of
     the structured query. The 'country' parameter contains a search term
     and will be handled with some fuzziness. The `countrycodes` parameter

-    is a hard filter and as such should be prefered. Having both parameters
+    is a hard filter and as such should be preferred. Having both parameters

     in the same query will work. If the parameters contradict each other,
     the search will come up empty.
 
     in the same query will work. If the parameters contradict each other,
     the search will come up empty.
 


@@ -187,6 +187,8 @@ also excluded when the filter is set.
 |-----------| ----- | ------- |
 | layer     | comma-separated list of: `address`, `poi`, `railway`, `natural`, `manmade` | _unset_ (no restriction) |
 
 |-----------| ----- | ------- |
 | layer     | comma-separated list of: `address`, `poi`, `railway`, `natural`, `manmade` | _unset_ (no restriction) |
 

+**`[Python-only]`**
+

 The layer filter allows to select places by themes.
 
 The `address` layer contains all places that make up an address:
 The layer filter allows to select places by themes.
 
 The `address` layer contains all places that make up an address:


@@ -201,7 +203,7 @@ The `railway` layer includes railway infrastructure like tracks.
 Note that in Nominatim's standard configuration, only very few railway
 features are imported into the database.
 
 Note that in Nominatim's standard configuration, only very few railway
 features are imported into the database.
 

-The `natural` layer collects feautures like rivers, lakes and mountains while
+The `natural` layer collects features like rivers, lakes and mountains while

 the `manmade` layer functions as a catch-all for features not covered by the
 other layers.
 
 the `manmade` layer functions as a catch-all for features not covered by the
 other layers.
 


@@ -215,7 +217,7 @@ the 'state', 'country' or 'city' part of an address. A featureType of
 settlement selects any human inhabited feature from 'state' down to
 'neighbourhood'.
 
 settlement selects any human inhabited feature from 'state' down to
 'neighbourhood'.
 

-When featureType ist set, then results are automatically restricted
+When featureType is set, then results are automatically restricted

 to the address layer (see above).
 
 !!! tip
 to the address layer (see above).
 
 !!! tip


@@ -225,7 +227,7 @@ to the address layer (see above).
 
 | Parameter | Value | Default |
 |-----------| ----- | ------- |
 
 | Parameter | Value | Default |
 |-----------| ----- | ------- |

-| exclude_place_ids | comma-separeted list of place ids |
+| exclude_place_ids | comma-separated list of place ids |

 
 If you do not want certain OSM objects to appear in the search
 result, give a comma separated list of the `place_id`s you want to skip.
 
 If you do not want certain OSM objects to appear in the search
 result, give a comma separated list of the `place_id`s you want to skip.


@@ -246,7 +248,7 @@ box. `x` is longitude, `y` is latitude.
 | bounded   | 0 or 1 | 0       |
 
 When set to 1, then it turns the 'viewbox' parameter (see above) into
 | bounded   | 0 or 1 | 0       |
 
 When set to 1, then it turns the 'viewbox' parameter (see above) into

-a filter paramter, excluding any results outside the viewbox.
+a filter parameter, excluding any results outside the viewbox.

 
 When `bounded=1` is given and the viewbox is small enough, then an amenity-only
 search is allowed. Give the special keyword for the amenity in square
 
 When `bounded=1` is given and the viewbox is small enough, then an amenity-only
 search is allowed. Give the special keyword for the amenity in square