mapbox / mapbox/mapbox-gl-geocoder
Document "Carmen format" more precisely
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 388
- Forks
- 181
- PR merge metrics
- No merged PRs in 30d
Description
The `localGeocoder` property is a function which returns results `in the Carmen GeoJSON format`. However, this statement is not enough to tell you which fields your function *must* provide.
It is also a bit loose, as the documentation for that format shows a `FeatureCollection`, whereas mapbox-gl-geocoder expects an array of `Feature`s.
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 documentation for the localGeocoder property and compare its stated Carmen GeoJSON format with the format expected by mapbox-gl-geocoder. Document which fields a returned Feature must provide and clarify that localGeocoder returns an array of Features rather than a FeatureCollection.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100