Why Option<_> (#746)

Add a comment about why `UnitQuaternion::rotation_between` returns an Option.
This commit is contained in:
CGMossa 2020-07-16 09:27:06 +02:00 committed by GitHub
parent f673979a2b
commit bc70258e5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 1 deletions

View File

@ -374,7 +374,8 @@ where
} }
/// The unit quaternion needed to make `a` and `b` be collinear and point toward the same /// The unit quaternion needed to make `a` and `b` be collinear and point toward the same
/// direction. /// direction. Returns `None` if both `a` and `b` are collinear and point to opposite directions, as then the
/// rotation desired is not unique.
/// ///
/// # Example /// # Example
/// ``` /// ```