Skip to content

Commit

Permalink
Fix some warnings in the sphinx build logs (#406)
Browse files Browse the repository at this point in the history
  • Loading branch information
eric-wieser committed Jul 20, 2021
1 parent d684ab1 commit 3d65bd7
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 14 deletions.
8 changes: 3 additions & 5 deletions clifford/_layout.py
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ class Layout(object):
algebra. This list determines the order of coefficients in the
internal representation of multivectors. The entry for the scalar
must be an empty tuple, and the entries for grade-1 vectors must be
singleton tuples. Remember, the length of the list will be ``2**dims`.
singleton tuples. Remember, the length of the list will be ``2**dims``.
Example::
Expand Down Expand Up @@ -266,8 +266,6 @@ class Layout(object):
dimensionality of vectors (``len(self.sig)``)
sig :
normalized signature, with all values ``+1`` or ``-1``
bladeTupList :
list of blades
gaDims :
2**dims
names :
Expand Down Expand Up @@ -673,8 +671,8 @@ def inv_func(self):
"""
Get a function that returns left-inverse using a computational linear algebra method
proposed by Christian Perwass.
-1 -1
M where M * M == 1
Computes :math:`M^{-1}` where :math:`M^{-1}M = 1`.
"""
mult_table = self.gmt
k_list, l_list, m_list = mult_table.coords
Expand Down
10 changes: 5 additions & 5 deletions clifford/taylor_expansions.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@
For example::
>>> from clifford.g3 import *
>>> import numpy as np
>>> np.sin(np.pi*e12/4)
(0.86867^e12)
>>> from clifford.g3 import *
>>> import numpy as np
>>> np.sin(np.pi*e12/4)
(0.86867^e12)
Implemented functions
----------------
---------------------
.. autofunction:: exp
.. autofunction:: sin
Expand Down
2 changes: 1 addition & 1 deletion docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Compatibility notes
and so ``mv[i]`` and ``len(mv)`` both emit :exc:`DeprecationWarning`s. If the underlying
storage order is of interest, use ``mv.value[i]`` and ``len(mv)``respectively. To obtain the
scalar part of a :class:`MultiVector`, use ``mv[()]`` instead of ``mv[0]``.
* ``Layout.gradeList`` has been removed. If still needed, it can be recovered as an :type:`ndarray`
* ``Layout.gradeList`` has been removed. If still needed, it can be recovered as an :class:`ndarray`
isntead of a :class:`list` via the private attribute ``layout._basis_blade_order.grades``
(:attr:`BasisBladeOrder.grades`).
* This will be the last release to support Python 3.5, which reached its end-of-life during our
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/euler-angles.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@
"metadata": {},
"source": [
"In 3 Dimenions, there is a simple formula which can be used to directly transform a rotations matrix into a rotor.\n",
"For arbitrary dimensions you have to use a different algorithm (see `clifford.tools.orthoMat2Versor()` ([docs](../generated/clifford.tools.orthoMat2Versor.rst))).\n",
"For arbitrary dimensions you have to use a different algorithm (see `clifford.tools.orthoMat2Versor()` ([docs](../api/generated/clifford.tools.orthoMat2Versor.rst))).\n",
"Anyway, in 3 dimensions there is a closed form solution, as described in Sec. 4.3.3 of \"Geometric Algebra for Physicists\".\n",
"Given a rotor $R$ which transforms an orthonormal frame $A={a_k}$ into $B={b_k}$ as such,\n",
"\n",
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/g3-algebra-of-space.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"First, we import clifford as `cf`, and instantiate a three dimensional geometric algebra using `Cl()` ([docs](../generated/clifford.Cl.rst))."
"First, we import clifford as `cf`, and instantiate a three dimensional geometric algebra using `Cl()` ([docs](../api/clifford.Cl.rst))."
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/space-time-algebra.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"source": [
"This notebook demonstrates how to use `clifford` to work with Space Time Algebra.\n",
"The Pauli algebra of space $\\mathbb{P}$, and Dirac algebra of space-time $\\mathbb{D}$, are related using the *spacetime split*.\n",
"The split is implemented by using a `BladeMap` ([docs](../generated/clifford.BladeMap.html)), which maps a subset of blades in $\\mathbb{D}$ to the blades in $\\mathbb{P}$.\n",
"The split is implemented by using a `BladeMap` ([docs](../api/clifford.BladeMap.rst)), which maps a subset of blades in $\\mathbb{D}$ to the blades in $\\mathbb{P}$.\n",
"This *split* allows a spacetime bivector $F$ to be broken up into relative electric and magnetic fields in space.\n",
"Lorentz transformations are implemented as rotations in $\\mathbb{D}$, and the effects on the relative fields are computed with the split. "
]
Expand Down

0 comments on commit 3d65bd7

Please sign in to comment.