Better documentation of what parser is?
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 64
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Description
Hey team,
I'm reading through as much of the pelias docs as I can find. I followed a link to pelias/parser and after reading through it (as well as https://geocode.earth/blog/2019/improved-autocomplete-parsing-is-here ) I think there could be some changes to the README that would help make it more understandable. Questions I still have
- what is the relationship to libpostal?
- what parts of pelias use parser vs libpostal? why?
- what is the precision/recall or similar performance of parser vs libpostal?
- if parser is meant to be better for autocomplete, why doesn't "111 8th a" guess it's a street? is that on the roadmap?
I would try to update the docs myself but I'm unclear as to the answers.
Best,
David
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the parser README and the linked Geocode Earth blog post, then review the existing issue discussion for answers about libpostal, usage, comparative performance, and autocomplete behavior. Done means the README clearly documents those relationships, tradeoffs, and roadmap details, with maintainers confirming any claims that are not available in the repository.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100