DM-7987: Ambiguous conversion between spherical coordinates and unit vectors #10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
smonkewitz
approved these changes
Nov 24, 2016
There was a problem hiding this comment.
Looks good to me. Two minor nits to address (or not) as you see fit: this package has been using Unicode (utf-8) in the comments, and using the Unicode equivalents to ° (°) and → (→) would fit in better. For me at least, this is also way more readable when looking at raw source. Secondly, in other documentation for this package, 3-vectors are written using parentheses rather than angle brackets.
Thanks for improving the docs!
The LonLat and UnitVector3d classes are now required to conform to specific coordinate conventions when converting between each other. Making these conventions part of the specification increases the number of classes that can delegate such coordinate conversions to sphgeom. This change formalizes existing behavior, and will not break client code. The conventions are documented at the class level rather than the method level, as each class has multiple methods that follow the same conventions.
kfindeisen
force-pushed
the
tickets/DM-7987
branch
from
fdf86a2
to
41ca9d9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch makes explicit
sphgeom's conventions for converting between vector and angular representations of a point on a sphere. It only formalizes existing behavior, so no client code should break. The conventions are documented at the class level rather than the method level, as each class has multiple conversion methods.