mapbox / mapbox/mapbox-gl-geocoder
consider unifying country / countries option with rest api and sdk-js
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 388
- Forks
- 181
- PR merge metrics
- No merged PRs in 30d
Description
It looks like the official API documentation specifies "country" as an option to restrict search countries, but this library uses "countries". It's a bit confusing, and reading source code isn't an ideal way to find this out.
Is there a reason it differs, or does it make sense to unify the component configuration with the mapbox API?
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
Compare the component's `countries` option with the official Geocoding API's `country` option and the sdk-js behavior, starting with the configuration and API request handling in the source code. Determine whether the names can be unified without breaking compatibility; done means the behavior and documentation follow a clear, agreed naming decision.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100