hans/Nominatim
1
0
Fork 1
mirror of https://github.com/osm-search/Nominatim.git synced 2026-03-11 05:14:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix: corrected Locale → Locales references and ensured proper casing in docs

Browse Source
This commit is contained in:
28Deepakpandey
2025-12-26 02:46:26 +05:30
parent 26e62fda19
commit f7ba1fc9e1
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/customize/Result-Formatting.md
View File

@@ -229,7 +229,7 @@ _None._
| Option | Description | | Option | Description |
|-----------------|-------------| |-----------------|-------------|
| locales | [Locale](../library/Result-Handling.md#locale) object for the requested language(s) | | locales | [Locales](../library/Result-Handling.md#locale) object for the requested language(s) |
| group_hierarchy | Setting of [group_hierarchy](../api/Details.md#output-details) parameter | | group_hierarchy | Setting of [group_hierarchy](../api/Details.md#output-details) parameter |
| icon_base_url | (optional) URL pointing to icons as set in [NOMINATIM_MAPICON_URL](Settings.md#nominatim_mapicon_url) | | icon_base_url | (optional) URL pointing to icons as set in [NOMINATIM_MAPICON_URL](Settings.md#nominatim_mapicon_url) |

8
docs/library/Getting-Started.md
View File

@@ -248,19 +248,19 @@ of the result. To do that, you first need to decide in which language the
results should be presented. As with the names in the result itself, the results should be presented. As with the names in the result itself, the
places in `address_rows` contain all possible name translation for each row. places in `address_rows` contain all possible name translation for each row.
The library has a helper class `Locale` which helps extracting a name of a The library has a helper class `Locales` which helps extracting a name of a
place in the preferred language. It takes a single parameter with a list place in the preferred language. It takes a single parameter with a list
of language codes in the order of preference. So of language codes in the order of preference. So
``` python ``` python
locale = napi.Locale(['fr', 'en']) locale = napi.Locales(['fr', 'en'])
``` ```
creates a helper class that returns the name preferably in French. If that is creates a helper class that returns the name preferably in French. If that is
not possible, it tries English and eventually falls back to the default `name` not possible, it tries English and eventually falls back to the default `name`
or `ref`. or `ref`.
The `Locale` object can be applied to a name dictionary to return the best-matching The `Locales` object can be applied to a name dictionary to return the best-matching
name out of it: name out of it:
``` python ``` python
@@ -273,7 +273,7 @@ component based on its `local_name` field. This is then utilized by the overall
which has a helper function to apply the function to all its ‘address_row’ members and saves which has a helper function to apply the function to all its ‘address_row’ members and saves
the result in the `locale_name` field. the result in the `locale_name` field.
However, in order to set this `local_name` field in a preferred language, you must use the `Locale` However, in order to set this `local_name` field in a preferred language, you must use the `Locales`
object which contains the function `localize_results`, which explicitly sets each `local_name field`. object which contains the function `localize_results`, which explicitly sets each `local_name field`.
``` python ``` python