enable CI tests for Ubuntu 24

[nominatim.git] / docs / library / Input-Parameter-Types.md

diff --git a/docs/library/Input-Parameter-Types.md b/docs/library/Input-Parameter-Types.md
index dae560b2929e8a19a91207f685e264e9ae190fe1..5c53773290fee36565b7396068b4414a7b390528 100644 (file)
--- a/docs/library/Input-Parameter-Types.md
+++ b/docs/library/Input-Parameter-Types.md
@@ -5,26 +5,26 @@ in the query functions of the API object.
 
 ## Place identification
 
 
 ## Place identification
 

-The [details](NominatimAPI.md#nominatim.api.core.NominatimAPI.details) and
-[lookup](NominatimAPI.md#nominatim.api.core.NominatimAPI.lookup) functions
-require references to places in the database. Below are listed the possible
-types for place identification. All types are dataclasses.
+The [details](NominatimAPI.md#nominatim_api.core.NominatimAPI.details) and
+[lookup](NominatimAPI.md#nominatim_api.core.NominatimAPI.lookup) functions
+require references to places in the database. Below the possible
+types for place identification are listed. All types are dataclasses.

 
 ### PlaceID
 
 
 ### PlaceID
 

-::: nominatim.api.PlaceID
+::: nominatim_api.PlaceID

     options:
         heading_level: 6
 
 ### OsmID
 
     options:
         heading_level: 6
 
 ### OsmID
 

-::: nominatim.api.OsmID
+::: nominatim_api.OsmID

     options:
         heading_level: 6
 
 ## Geometry types
 
     options:
         heading_level: 6
 
 ## Geometry types
 

-::: nominatim.api.GeometryFormat
+::: nominatim_api.GeometryFormat

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


@@ -33,14 +33,14 @@ types for place identification. All types are dataclasses.
 
 ### Point
 
 
 ### Point
 

-::: nominatim.api.Point
+::: nominatim_api.Point

     options:
         heading_level: 6
         show_signature_annotations: True
 
 ### Bbox
 
     options:
         heading_level: 6
         show_signature_annotations: True
 
 ### Bbox
 

-::: nominatim.api.Bbox
+::: nominatim_api.Bbox

     options:
         heading_level: 6
         show_signature_annotations: True
     options:
         heading_level: 6
         show_signature_annotations: True


@@ -49,8 +49,12 @@ types for place identification. All types are dataclasses.
 
 ## Layers
 
 
 ## Layers
 

-::: nominatim.api.DataLayer
-    options:
-        heading_level: 6
+Layers allow to restrict the search result to thematic groups. This is
+orthogonal to restriction by address ranks, which groups places by their
+geographic extent.

 
 
 
 

+::: nominatim_api.DataLayer
+    options:
+        heading_level: 6
+        members_order: source