pelias / pelias/api

Search-string aware label generation

Open
#721 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ideas
Dominant language
JavaScript
Stars
259
Forks
168
Avg merge
6h 15m
Merged PRs (30d)
1

Description

Currently labels are generated using a fixed format. Here in finland, addresses can be expressed in 2 standard ways:

name/street addr, postalcode, locality
name/street addr, postalcode, localadmin

Locality resembles the division to postal code areas and is hence quite a natural way to express a post address. Also, locality often refers to the traditional well known area name, whereas localadmin is the current administrative division, in which several localities have been joined. Spoken language often prefers locality.

Other countries may have similar conventions.

I would be a nice option if search results could use the same convention as expressed in the query. If the user searches 'Ojatie, Kuru', he probably expects to get exactly that address, not 'Ojatie, Ylöjärvi'.

The desired convention/behavior can also depend on the application using the geocoding service. Configurability will be a good way to tackle this.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by locating the fixed-format label-generation and search-result formatting paths, then determine how the query’s address convention and application-specific configuration should be represented. Done means a documented, tested behavior for selecting labels such as locality versus localadmin.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.