Merge pull request #22 from glotzerlab/docs/issue21

Update geometry.angle docstring
glotzerlab · Sep 17, 2019 · 8c42717 · 8c42717
2 parents 4da63d8 + 876bfe9
commit 8c42717
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/ChangeLog.rst b/ChangeLog.rst
@@ -5,6 +5,11 @@ This project adheres to `Semantic Versioning <http://semver.org/spec/v2.0.0.html
 Unreleased
 ----------
 
+Fixed
++++++
+
+* Docstring of geometry.angle was missing a factor of 2 in the comparison to intrinsic_distance.
+
 v1.2.2 - 2019-09-11
 -------------------
 

diff --git a/rowan/geometry/__init__.py b/rowan/geometry/__init__.py
@@ -215,7 +215,7 @@ def angle(p):
     R"""Compute the angle of rotation of a quaternion.
 
     Note that this is identical to
-    ``intrinsic_distance(p, np.array([1, 0, 0, 0]))``.
+    ``2*intrinsic_distance(p, np.array([1, 0, 0, 0]))``.
 
     Args:
         p ((...,4) np.array): Array of quaternions.