docfixs

pygae · Jan 4, 2021 · 5d81208 · 5d81208
1 parent d283fa5
commit 5d81208
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/clifford/tools/__init__.py b/clifford/tools/__init__.py
@@ -192,8 +192,11 @@ def mat2Frame(A: np.ndarray,
 
 def frame2Mat(B, A=None, I=None, is_complex=None):
     '''
+
     convert a list of vectors to a matrix
 
+    Parameters
+    ------------
     B : list
         a list of vectors that have been transformed
     A : None, list of vectors
@@ -437,6 +440,14 @@ def orthoMat2Versor(A, eps=None, I=None, is_complex=None):
 
     Parameters
     ------------
+    A : matrix
+        matrix to be transformed
+    eps : number
+        tolerance
+    I : MultiVector
+        GA  of A
+    is_complex : boolean
+        is A complex?
 
     '''
     B, layout = mat2Frame(A, I=I, is_complex=is_complex)

diff --git a/docs/tutorials/euler-angles.ipynb b/docs/tutorials/euler-angles.ipynb
@@ -50,8 +50,7 @@
     "2. rotate about the rotated $e_1$-axis, call it  $e_1^{'}$\n",
     "3. rotate about the twice rotated axis of $e_3$-axis, call it  $e_3^{''}$\n",
     "\n",
-    "So the elemental rotations are about  $e_3,  e_{1}^{'},  e_3^{''}$-axes, respectively.",
-    "\n",
+    "So the elemental rotations are about  $e_3,  e_{1}^{'},  e_3^{''}$-axes, respectively.\n",
     "![](../_static/Euler2a.gif)\n",
     "\n",
     "(taken from wikipedia)"