Added JSDocs to cheap-ruler

mapbox / cheap-ruler

Fast approximations for common geodesic measurements 🌐

https://www.mapbox.com/blog/cheap-ruler/

ISC License

417 stars 32 forks source link

Added JSDocs to cheap-ruler #20

Closed DenisCarriere closed 8 years ago

DenisCarriere commented 8 years ago

@tmcw @mourner please review to make sure the JSDocs is accurate.

mourner commented 8 years ago

Thanks for taking time to contribute! I'm generally not a fan of JSDoc, but it makes sense in this repo.

DenisCarriere commented 8 years ago

@mourner I can tell that you're not a fan :) The hardest part is the initial documentation and you've done a great job defining it which I thank you! I wrote the JSDocs for the TypeScript definition I just figured it would be best to also match those same JSDocs in your source code.

You've got a lot more libraries I want to tackle, you're libraries are awesome! Very clean work.