Fixup docstrings for mv and lt #56

eric-wieser · 2019-11-20T12:43:02Z

This:

Uses math and code formatting where appropriate
Promotes some comments to docstrings
Ensures dead commented out code does not end up as a docstring
Fixes some typos
Merges docstrings duplicated between cls.__doc__ and cls.__init__.__doc__

Results:

https://external-builds.readthedocs.io/html/galgebra/56/generated/galgebra.mv.html
https://external-builds.readthedocs.io/html/galgebra/56/generated/galgebra.lt.html

codecov · 2019-11-20T12:52:09Z

Codecov Report

Merging #56 into master will not change coverage.
The diff coverage is 100%.

@@          Coverage Diff           @@
##           master     #56   +/-   ##
======================================
  Coverage    66.7%   66.7%           
======================================
  Files           8       8           
  Lines        4890    4890           
======================================
  Hits         3262    3262           
  Misses       1628    1628

Impacted Files	Coverage Δ
galgebra/lt.py	`43% <ø> (ø)`	⬆️
galgebra/mv.py	`61.7% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a2a34f5...c3537c2. Read the comment docs.

galgebra/lt.py

eric-wieser · 2019-11-20T13:22:27Z

Looking at #52, it doesn't appear this will create any conflicts

galgebra/mv.py

galgebra/lt.py

utensil · 2019-11-23T13:54:38Z

galgebra/lt.py

-                        = grad_j|(grad_i*F(v_1,...,v_i,...,v_j,...,v_r)).
-    This returns a mlt with slot i and j removed.
+
+    .. math:: F(v_1,...,v_r;v_{r+1}) = (v_{r+1} \bullet \nabla)F(v_1,...,v_j,...,v_r).


@eric-wieser Besides the change suggestions submitted, it would be better to introduce the \bullet somewhere before using it. There're multiple occurrences, but I think it's ok to be a little repetitive. Just like the clause, "where ∗ is any of the multivector multiplicative operations. "

Bullet is already in the docs for Ga.hestenes_product I think

This: * Uses math and code formatting where appropriate * Promotes some comments to docstrings * Ensures dead commented out code does not end up as a docstring * Fixes some typos * Merges docstrings duplicated between `cls.__doc__` and `cls.__init__.__doc__`

eric-wieser force-pushed the clean-mv-docstrings branch from 8dde09d to c41b7bf Compare November 20, 2019 12:54

eric-wieser commented Nov 20, 2019

View reviewed changes

galgebra/lt.py Outdated Show resolved Hide resolved

eric-wieser force-pushed the clean-mv-docstrings branch 2 times, most recently from 2dcb50e to fe49303 Compare November 20, 2019 13:16

eric-wieser marked this pull request as ready for review November 20, 2019 13:17

eric-wieser force-pushed the clean-mv-docstrings branch 3 times, most recently from 23db121 to 8cba360 Compare November 22, 2019 13:25