KieranWynn / pyquaternion

A fully featured, pythonic library for representing and using quaternions
http://kieranwynn.github.io/pyquaternion/
MIT License
339 stars 68 forks source link

Error in Basic Usage Documents #84

Open Wave1art opened 1 year ago

Wave1art commented 1 year ago

There appears to be an error in the section about quaternion chaining in Basic Usage.

Either pyQuaternion does not follow standard quaternion multiplication conventions (I don't think so) or the example is incorrect, more likely and what a brief test implies.

>>> q3 = q1 * q2 # Composite rotation of q1 then q2 expressed as standard multiplication

This should instead be: q3 = q2 * q1 ...

Note the swapped order of q2 and q1.

I initially thought this meant that pyquaternion does not follow the standard convention but testing suggests that it is correct but this documentation is quite misleading.

The library is otherwise awesome so thank you!