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

Document that euler angles should be in radians for quaternion constructor #298

Merged
merged 1 commit into from
Dec 7, 2021

Conversation

adlarkin
Copy link
Contributor

@adlarkin adlarkin commented Dec 7, 2021

Signed-off-by: Ashton Larkin 42042756+adlarkin@users.noreply.github.com

Summary

To help remove confusion for users, I added a note that the quaternion constructor that takes a euler angle vector expects the angles to be in radians.

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge

…uctor

Signed-off-by: Ashton Larkin <42042756+adlarkin@users.noreply.github.com>
@github-actions github-actions bot added Gazebo 1️1️ Dependency of Gazebo classic version 11 🌱 garden Ignition Garden 🏢 edifice Ignition Edifice 🏯 fortress Ignition Fortress 🏰 citadel Ignition Citadel 🔮 dome Ignition Dome labels Dec 7, 2021
@codecov
Copy link

codecov bot commented Dec 7, 2021

Codecov Report

Merging #298 (4269706) into ign-math6 (afd0b22) will not change coverage.
The diff coverage is n/a.

❗ Current head 4269706 differs from pull request most recent head a1aeb21. Consider uploading reports for the commit a1aeb21 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           ign-math6     #298   +/-   ##
==========================================
  Coverage      99.65%   99.65%           
==========================================
  Files             67       67           
  Lines           6359     6359           
==========================================
  Hits            6337     6337           
  Misses            22       22           
Impacted Files Coverage Δ
include/ignition/math/Quaternion.hh 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update afd0b22...a1aeb21. Read the comment docs.

@chapulina chapulina added the documentation Improvements or additions to documentation label Dec 7, 2021
@adlarkin adlarkin merged commit d338701 into ign-math6 Dec 7, 2021
@adlarkin adlarkin deleted the adlarkin/quaternion_constructor_unit_docs branch December 7, 2021 03:47
@osrf-triage
Copy link

This pull request has been mentioned on Gazebo Community. There might be relevant details there:

https://community.gazebosim.org/t/new-ignition-releases-2022-03-01-citadel-edifice-fortress/1313/1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏰 citadel Ignition Citadel documentation Improvements or additions to documentation 🔮 dome Ignition Dome 🏢 edifice Ignition Edifice 🏯 fortress Ignition Fortress 🌱 garden Ignition Garden Gazebo 1️1️ Dependency of Gazebo classic version 11
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants