From 3e718e40d929403b3558e0bfcdd81eef04bac2d6 Mon Sep 17 00:00:00 2001 From: Sarah Hoffmann Date: Fri, 21 Feb 2025 17:16:42 +0100 Subject: [PATCH] adapt documentation for PhraseType type --- docs/develop/ICU-Tokenizer-Modules.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/develop/ICU-Tokenizer-Modules.md b/docs/develop/ICU-Tokenizer-Modules.md index f19002c2..30b85ac7 100644 --- a/docs/develop/ICU-Tokenizer-Modules.md +++ b/docs/develop/ICU-Tokenizer-Modules.md @@ -60,13 +60,19 @@ The order of phrases matters to Nominatim when doing further processing. Thus, while you may split or join phrases, you should not reorder them unless you really know what you are doing. -Phrase types (`nominatim_api.search.PhraseType`) can further help narrowing -down how the tokens in the phrase are interpreted. The following phrase types -are known: - -::: nominatim_api.search.PhraseType - options: - heading_level: 6 +Phrase types can further help narrowing down how the tokens in the phrase +are interpreted. The following phrase types are known: + +| Name | Description | +|----------------|-------------| +| PHRASE_ANY | No specific designation (i.e. source is free-form query) | +| PHRASE_AMENITY | Contains name or type of a POI | +| PHRASE_STREET | Contains a street name optionally with a housenumber | +| PHRASE_CITY | Contains the postal city | +| PHRASE_COUNTY | Contains the equivalent of a county | +| PHRASE_STATE | Contains a state or province | +| PHRASE_POSTCODE| Contains a postal code | +| PHRASE_COUNTRY | Contains the country name or code | ## Custom sanitizer modules -- 2.39.5