alexreisner / alexreisner/geocoder
Documentation and/or consistency issue
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 6.4k
- Forks
- 1.2k
- PR merge metrics
- No merged PRs in 30d
Description
Hi @alexreisner,
first off: thank you, amazing work 💯
I'm a little confused by the following:
- Using
Geocoder.searchleads to@datacontaining"lat"and"lon". - The documentation suggests stubbing
"coordinates". - When using
Model.geocode, it is expected that the coordinates are present within@datain"latitude"and"longitude"
My questions:
- Is there a reason for this deviation?
- Is stubbing
coordinatesmaybe deprecated? - What are the arguments against either using the short form (
lat) or the long form (latitude) consistently?
Cheers,
Finn
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 README testing section and lib/geocoder/results/base.rb, then compare the documented coordinates stub with the lat/lon data returned by Geocoder.search and the latitude/longitude expectations of Model.geocode. Done means the project has a decided, consistent convention and documentation for these coordinate keys.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100