alexreisner / alexreisner/geocoder

Documentation and/or consistency issue

Open
#1,685 1 comment 0 reactions 0 assignees View on GitHub

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:

  1. Using Geocoder.search leads to @data containing "lat" and "lon".
  2. The documentation suggests stubbing "coordinates".
  3. When using Model.geocode, it is expected that the coordinates are present within @data in "latitude" and "longitude"

My questions:

  • Is there a reason for this deviation?
  • Is stubbing coordinates maybe deprecated?
  • What are the arguments against either using the short form (lat) or the long form (latitude) consistently?

Cheers,

Finn

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.