From bc70258e5c6c0057efdc659ea533119c028e7e96 Mon Sep 17 00:00:00 2001
From: CGMossa <cgmossa@gmail.com>
Date: Thu, 16 Jul 2020 09:27:06 +0200
Subject: [PATCH] Why Option<_> (#746)

Add a comment about why `UnitQuaternion::rotation_between` returns an Option.
---
 src/geometry/quaternion_construction.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/geometry/quaternion_construction.rs b/src/geometry/quaternion_construction.rs
index 175275d4..a59d3030 100644
--- a/src/geometry/quaternion_construction.rs
+++ b/src/geometry/quaternion_construction.rs
@@ -374,7 +374,8 @@ where
     }
 
     /// 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
     /// ```