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

Remove ambiguity in kinematics.rst #745

Merged
merged 2 commits into from
Aug 14, 2023
Merged

Remove ambiguity in kinematics.rst #745

merged 2 commits into from
Aug 14, 2023

Conversation

uavster
Copy link
Contributor

@uavster uavster commented Aug 14, 2023

The current phrasing ("it specifies that a collision check between the two bodies is either not required or wanted") is ambiguous.

Description

I guess the intended meaning was "the collision check is not required or the collision is wanted". I removed the "wanted" part to keep the wording consistent with the next sentence and remove the apparent redundancy.

Checklist

  • Required by CI: Code is auto formatted using clang-format
  • While waiting for someone to review your request, please consider reviewing another open pull request to support the maintainers

The current phrasing is ambiguous. "Or wanted" sounds in contradiction with "not required". I guess the intended meaning was "either not required or _not_ wanted", but that sounds redundant, so I removed the "wanted" part in favor of "not required" to use the same wording as the next sentence.
Copy link
Contributor

@sjahr sjahr left a comment

Choose a reason for hiding this comment

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

Good catch! What do you think about being even more specific about that? I think not required suggests that it might be an optional check but my understanding is that there won't be a check at all

doc/concepts/kinematics.rst Outdated Show resolved Hide resolved
@uavster
Copy link
Contributor Author

uavster commented Aug 14, 2023

Good catch! What do you think about being even more specific about that? I think not required suggests that it might be an optional check but my understanding is that there won't be a check at all

Much clearer. Thank you!

@uavster uavster merged commit e5f0821 into main Aug 14, 2023
9 checks passed
@uavster uavster deleted the uavster-remove-ambiguity branch August 14, 2023 14:16
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.

2 participants