Unclear how to instantiate geocodingClient object
Open
Nobody has claimed this yet.
documentation
- Dominant language
- JavaScript
- Stars
- 768
- Forks
- 191
- PR merge metrics
- No merged PRs in 30d
Description
Docs issue: The documentation examples for the geocoding service look great but it's unclear how to import/instantiate the geocodingClient object that all of the examples use. For example, with the reverse geocoding example:
geocodingClient.reverseGeocode({
query: [-95.4431142, 33.6875431]
}) ...
... where do you get the geocodingClient object?
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 with the documentation examples for the geocoding service, especially the reverse geocoding example using geocodingClient. Add the missing import or instantiation guidance so readers know where the object comes from, then verify that the example is understandable from the documentation alone.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100