Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixup docstrings for mv and lt #56

Merged
merged 1 commit into from Nov 24, 2019

Conversation

@eric-wieser
Copy link
Contributor

eric-wieser commented Nov 20, 2019

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

This comment has been minimized.

Copy link

codecov bot commented Nov 20, 2019

Codecov Report

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

Impacted file tree graph

@@          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.

@eric-wieser eric-wieser force-pushed the eric-wieser:clean-mv-docstrings branch from 8dde09d to c41b7bf Nov 20, 2019
galgebra/lt.py Outdated Show resolved Hide resolved
@eric-wieser eric-wieser force-pushed the eric-wieser:clean-mv-docstrings branch 2 times, most recently from 2dcb50e to fe49303 Nov 20, 2019
@eric-wieser eric-wieser marked this pull request as ready for review Nov 20, 2019
@eric-wieser

This comment has been minimized.

Copy link
Contributor Author

eric-wieser commented Nov 20, 2019

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

@eric-wieser eric-wieser force-pushed the eric-wieser:clean-mv-docstrings branch 3 times, most recently from 23db121 to 8cba360 Nov 21, 2019
galgebra/mv.py Outdated Show resolved Hide resolved
galgebra/mv.py Outdated Show resolved Hide resolved
galgebra/mv.py Outdated Show resolved Hide resolved
galgebra/mv.py Outdated Show resolved Hide resolved
galgebra/mv.py Show resolved Hide resolved
galgebra/lt.py Outdated Show resolved Hide resolved
= 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).

This comment has been minimized.

Copy link
@utensil

utensil Nov 23, 2019

Member

@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. "

This comment has been minimized.

Copy link
@eric-wieser

eric-wieser Nov 24, 2019

Author Contributor

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 eric-wieser force-pushed the eric-wieser:clean-mv-docstrings branch from 8cba360 to c3537c2 Nov 24, 2019
@utensil utensil merged commit 5ae058c into pygae:master Nov 24, 2019
5 checks passed
5 checks passed
Travis CI - Pull Request Build Passed
Details
codebeat no reportable quality changes
Details
codecov/patch 100% of diff hit (target 66.7%)
Details
codecov/project 66.7% (+0%) compared to a2a34f5
Details
continuous-documentation/read-the-docs Read the Docs build succeeded!
Details
@utensil utensil added this to the 0.4.5 milestone Nov 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.