Merge pull request #3593 from lonvia/order-by-bbox

[nominatim.git] / docs / library / Result-Handling.md

diff --git a/docs/library/Result-Handling.md b/docs/library/Result-Handling.md
index af2a818494a4e7e4304563be8695d5eedb032ee5..1e8043cf9e842bd24af72d671f854d42d6f8a5c8 100644 (file)
--- a/docs/library/Result-Handling.md
+++ b/docs/library/Result-Handling.md
@@ -1,7 +1,7 @@
 # Result handling
 
 # Result handling
 

-The search functions of the Nominatim API always return a result object that
-contains the full raw information about the place that is available in the
+The search functions of the Nominatim API always return a result object
+with the raw information about the place that is available in the

 database. This section discusses data types used in the results and utility
 functions that allow further processing of the results.
 
 database. This section discusses data types used in the results and utility
 functions that allow further processing of the results.
 


@@ -9,10 +9,10 @@ functions that allow further processing of the results.
 
 ### Sources
 
 
 ### Sources
 

-Nominatim takes the result data from multiple souces. The `source_table` field
-in the result describes, from which source the result was retrived.
+Nominatim takes the result data from multiple sources. The `source_table` field
+in the result describes, from which source the result was retrieved.

 
 

-::: nominatim.api.SourceTable
+::: nominatim_api.SourceTable

     options:
         heading_level: 6
         members_order: source
     options:
         heading_level: 6
         members_order: source


@@ -21,17 +21,17 @@ in the result describes, from which source the result was retrived.
 
 When the `address_details` parameter is set, then functions return not
 only information about the result place but also about the place that
 
 When the `address_details` parameter is set, then functions return not
 only information about the result place but also about the place that

-make up the address. This information is almost always required, when you
+make up the address. This information is almost always required when you

 want to present the user with a human-readable description of the result.
 See also [Localization](#localization) below.
 
 The address details are available in the `address_rows` field as a ordered
 list of `AddressLine` objects with the country information last. The list also
 contains the result place itself and some artificial entries, for example,
 want to present the user with a human-readable description of the result.
 See also [Localization](#localization) below.
 
 The address details are available in the `address_rows` field as a ordered
 list of `AddressLine` objects with the country information last. The list also
 contains the result place itself and some artificial entries, for example,

-for the housenumber or the country code. This makes processing and creating
-a full address easiert.
+for the house number or the country code. This makes processing and creating
+a full address easier.

 
 

-::: nominatim.api.AddressLine
+::: nominatim_api.AddressLine

     options:
         heading_level: 6
         members_order: source
     options:
         heading_level: 6
         members_order: source


@@ -43,7 +43,7 @@ may be used to find a place, when the `keywords` parameter is set. Search
 terms are split into terms for the name of the place and search terms for
 its address.
 
 terms are split into terms for the name of the place and search terms for
 its address.
 

-::: nominatim.api.WordInfo
+::: nominatim_api.WordInfo

     options:
         heading_level: 6
 
     options:
         heading_level: 6
 


@@ -53,6 +53,6 @@ Results are always returned with the full list of available names.
 
 ### Locale
 
 
 ### Locale
 

-::: nominatim.api.Locales
+::: nominatim_api.Locales

     options:
         heading_level: 6
     options:
         heading_level: 6