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

Updated and restructured library documentation to include Locale changes

Browse Source 
Updated Getting Started Docs

Added documentation for Result Handling

removed api documentation
This commit is contained in:
anqixxx
2025-08-20 09:54:25 -04:00
parent 196de9e974
commit 4cdd2526b6
2 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -268,13 +268,17 @@ name out of it:
'Brugges'
```
The `address_row` field has a helper function to apply the function to all
its members and save the result in the `local_name` field. It also returns
all the localized names as a convenient simple list. This list can be used
to create a human-readable output:
The `address_row` field has a helper function to compute the display name for each Address Line
component based on its `local_name` field. This is then utilized by the overall `result` object,
which has a helper function to apply the function to all its ‘address_row’ members and saves
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`
object which contains the function `localize_results`, which explicitly sets each `local_name field`.
``` python
>>> address_parts = results[0].address_rows.localize(locale)
>>> Locales().localize_results(results)
>>> address_parts = results[0].address_rows
>>> print(', '.join(address_parts))
Bruges, Flandre-Occidentale, Flandre, Belgique
```

6
docs/library/Result-Handling.md
View File

@@ -49,7 +49,11 @@ its address.
## Localization
Results are always returned with the full list of available names.
Results are always returned with the full list of available names. However, the
default `locale_name` must be explicitly set using the `localize` function within
`Locales`. This parses through the full list of available names to find the one
most preferred by the user. Once this is set, the user can simply use the
`display_name` field within a `Result` object to retrive the localized name.
### Locale