-
Notifications
You must be signed in to change notification settings - Fork 455
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Rename distance* functions to greatCircleDistance* #622
Conversation
src/h3lib/include/h3api.h.in
Outdated
@@ -319,14 +319,14 @@ DECLSPEC double H3_EXPORT(radsToDegs)(double radians); | |||
* @{ | |||
*/ | |||
/** @brief "great circle distance" between pairs of LatLng points in radians*/ | |||
DECLSPEC double H3_EXPORT(distanceRads)(const LatLng *a, const LatLng *b); | |||
DECLSPEC double H3_EXPORT(latLngDistanceRads)(const LatLng *a, const LatLng *b); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please update the docs - API docs, upgrade instructions, and CHANGELOG.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, thanks. When upgrading the docs I assumed that JS and Java would use latLngDistance
and Python would use latlng_distance
.
Sorry, I'm waffling on this, but I'm currently leaning toward
Too late to consider this version? |
I guess "haversine" isn't used in the the OGC names. Its ...but i don't think we're considering calling it |
Per offline discussion: The intent of this change is to disambiguate the point-to-point distance functions from the grid distance functions, particularly in binding contexts where the unit suffix may be lost.
This was just a straight search-and-replace, no other code changes.