search

OpenCageData / scala-opencage-geocoder

Scala client for the OpenCage forward/reverse geocoding API
Other
4 stars 2 forks source link

Modifications for OpenCage's Library guidelines #3

Closed tonicebrian closed 5 years ago

tonicebrian commented 5 years ago

Here is an overview of changes that I've found following OpenCage's library guidelines.

  1. First I've added some cosmetic changes following scalastyle guidelines and bumped required sbt version to latest (https://github.com/nmdguerreiro/scala-opencage-geocoder/commit/25404094f98628d84d514bfaaea96627ce7ff5f4)
  2. Provide User Agent on all the calls (https://github.com/nmdguerreiro/scala-opencage-geocoder/commit/48a480de60794d84cf3f1ea614304371db27f016)
  3. Address documention pointers from points 6 and 7 of the guidelines (https://github.com/tonicebrian/scala-opencage-geocoder/commit/dfebb52eb214e570d962bf1f377cff4124eeaf36 ) and (https://github.com/tonicebrian/scala-opencage-geocoder/commit/7cd7941615391e91bdf75fd175eb195e56fb0039)
  4. Add missing parameters from the API (https://github.com/nmdguerreiro/scala-opencage-geocoder/commit/9de2f8dd38a60efcac4393eb90ae719b3495fb82). Here I’ve decided to not include “jsonp” parameter as part of the Scala client, mainly because it only makes sense when running as Javascript in a web page and it will make the client API a bit convoluted.
  5. Moved App example from code to documentation. This will make the library leaner by removing extraneous dependency scopt (https://github.com/nmdguerreiro/scala-opencage-geocoder/commit/b47417789a9343e0d6a4159d3c6a8158a6160f48)