Skip to content
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

Clarify vector semantics #115

Merged
merged 4 commits into from
May 19, 2020
Merged

Clarify vector semantics #115

merged 4 commits into from
May 19, 2020

Conversation

tfoote
Copy link
Contributor

@tfoote tfoote commented May 18, 2020

Fixes #92

Fixes #92

Signed-off-by: Tully Foote <tfoote@osrfoundation.org>
@@ -1,4 +1,7 @@
# This represents a Vector3 with reference coordinate frame and timestamp

# Note that this follows vector semantics with it alwasy being at the origin,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Note that this follows vector semantics with it alwasy being at the origin,
# Note that this follows vector semantics with it always anchored at the origin,

Signed-off-by: Tully Foote <tfoote@osrfoundation.org>
@tfoote tfoote self-assigned this May 18, 2020
@@ -1,5 +1,10 @@
# This represents a vector in free space.

# This is semantically different than a point.
# A vector is always anchored at the origin.
# When a trasform is applied to a vector only
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# When a trasform is applied to a vector only
# When a transform is applied to a vector only

Signed-off-by: Tully Foote <tfoote@osrfoundation.org>
@tfoote tfoote requested a review from jacobperron May 19, 2020 08:50
Copy link
Member

@mjcarroll mjcarroll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with suggestions applied.

Only nit is that your wrapping is inconsistent between the two files (wrapping at comma in one and at fixed length at other?)

Signed-off-by: Tully Foote <tfoote@osrfoundation.org>
@tfoote tfoote merged commit dd4b1ec into master May 19, 2020
@delete-merged-branch delete-merged-branch bot deleted the point_vector_semantics branch May 19, 2020 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documntation of semantic difference between Point and Vector
4 participants