From b15eaf4ffb795687a6913fa6e21173c33aaab83b Mon Sep 17 00:00:00 2001
From: Jonas Pleyer <jonas.pleyer@fdm.uni-freiburg.de>
Date: Thu, 13 Jun 2024 16:53:37 +0200
Subject: [PATCH] enhance description and add small ascii plot

- also make one vector larger in order to make clear from example
  that the length of the vectors does not matter
---
 src/base/matrix.rs | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/src/base/matrix.rs b/src/base/matrix.rs
index f3c64a30..ea88692e 100644
--- a/src/base/matrix.rs
+++ b/src/base/matrix.rs
@@ -2116,14 +2116,24 @@ impl<T: crate::SimdRealField + SimdPartialOrd + ClosedMul, R: Dim, C: Dim, S: Ra
 {
     /// Calculate the right-handed angle between two vectors in radians.
     ///
-    /// This function always yields a positive result `x` between `0.0` and `2.0*PI`.
+    /// This function is very different to the [angle] function.
+    /// It always yields a positive result `x` between `0.0` and `2.0*PI` and is only applicable
+    /// for 2D vectors.
+    /// In the following example, we calculate the right-handed angle between the following two
+    /// vectors.
+    /// ```ignore
+    ///       p
+    ///      │
+    ///      │
+    ///      └─────── q
+    /// ```
     /// Note that the order in which the arguments are executed plays an important role.
     /// Furthermore, we can see that the sum of both results `PI/2.0` and `3.0*PI/2.0` add up to a
     /// total of `2.0*PI`.
     /// ```
     /// # use nalgebra::Vector2;
     /// let p = Vector2::from([0.0, 1.0]);
-    /// let q = Vector2::from([1.0, 0.0]);
+    /// let q = Vector2::from([2.0, 0.0]);
     ///
     /// let abs_diff1 = (p.angle_right_handed(&q) - std::f64::consts::FRAC_PI_2).abs();
     /// let abs_diff2 = (q.angle_right_handed(&p) - 3.0 * std::f64::consts::FRAC_PI_2).abs();