Skip to content

docs: improve documentation of available GA operations in README#548

Merged
utensil merged 3 commits intopygae:masterfrom
utiberious:fix/issue-523-readme-operations
Mar 30, 2026
Merged

docs: improve documentation of available GA operations in README#548
utensil merged 3 commits intopygae:masterfrom
utiberious:fix/issue-523-readme-operations

Conversation

@utiberious
Copy link
Copy Markdown
Contributor

@utiberious utiberious commented Mar 30, 2026

Summary

Expands the README section on available operations with HTML tables documenting operators, methods, and their descriptions. Replaces the previous LaTeX math blocks that didn't render on GitHub.

Fixes #523

Changes

  • README.md: Replace LaTeX operator table with HTML tables covering:
    • Arithmetic operators (+, -, *, /, ^, |, <, >)
    • Mv methods (rev, dual, inv, norm, components, etc.)
    • Ga factory methods (mv, I, grad, etc.)

Test plan

  • No code changes, docs only

@utiberious
Improve documentation of available GA operations in README
334f69c 
Replace LaTeX math blocks with HTML tables for operator and method
documentation. This renders correctly on GitHub, Sphinx, and PyPI.
Added new operations introduced in PR 510 (undual, grade involution,
Clifford conjugation, magnitude, scalar product, quadratic form,
components, etc.) and scalar/Mv division.

Fixes #9
@utensil
Copy link
Copy Markdown
Member

utensil commented Mar 30, 2026 •
edited
Loading

Thanks, this looks good. CI passes, docs only, and directly addresses #523's ask for HTML tables following kingdon's style.

One thing: A.components() is listed with description 'Component dictionary' but the existing method at mv.py:984 returns List[Mv], not a dict. That description is borrowed from PR #547 which won't be merged. Worth fixing the description to match what's actually there.

Kingdon cross-check: issue #523 explicitly said 'follow kingdon' — kingdon's README uses the same HTML table style, so this is on the right track.

@utiberious
Copy link
Copy Markdown
Contributor Author

utiberious commented Mar 30, 2026

Fixed: changed components() description from 'Component dictionary' to 'List of single-blade components' to match the actual List[Mv] return type at mv.py:984. Pushed in 8cc52be.

@utensil
Copy link
Copy Markdown
Member

utensil commented Mar 30, 2026 •
edited by unfurl-links bot
Loading

Thanks for the update! Docs build looks good at https://galgebra--548.org.readthedocs.build/en/548/. One issue: the <details> tags collapse the tables — users are very likely to miss them. Could you remove the <details>/<summary> wrappers and keep the tables fully expanded?

@utiberious
Copy link
Copy Markdown
Contributor Author

utiberious commented Mar 30, 2026

Removed the <details>/<summary> wrappers. Tables are now fully expanded and visible. Pushed in 234c011.

@utensil utensil merged commit c248271 into pygae:master Mar 30, 2026
6 checks passed
@utensil utensil added component: docs Documentation state: needs changelog Needs a changelog entry before the next release. Remove this label when the changelog is done. labels Mar 31, 2026
@utensil utensil added this to the 0.6.0 milestone Mar 31, 2026
utiberious added a commit to utiberious/galgebra that referenced this pull request Apr 1, 2026
@utiberious
docs: add 0.6.0 changelog entries
ba4f9fc 
Groups new entries by: features, bug fixes, examples/docs, tests/maintenance.

Features: Cl() kingdon interface (pygae#550, closes pygae#524), Mv.__rtruediv__
(pygae#543, closes pygae#512), shirokov_inverse/hitzer_inverse (pygae#530).

Bugs: interop dual mode contamination (pygae#556, closes pygae#555), norm() Abs
wrapping (pygae#554, closes pygae#522), is_versor() improvement (pygae#536, closes pygae#533).

Examples/docs: sundial + cheatsheet tests (pygae#549+pygae#557, closes pygae#506),
coords tutorial (pygae#551), README ops (pygae#548, closes pygae#523).

Tests/maintenance: lt.matrix() regression tests (pygae#558, closes pygae#461),
extra-cdot regression test (pygae#545), er_blade + ReciprocalFrame refactors
(pygae#552+pygae#553), CI fix (pygae#535).
@utiberious utiberious mentioned this pull request Apr 1, 2026
Merged
utensil pushed a commit that referenced this pull request Apr 1, 2026
@utiberious
docs: add 0.6.0 changelog entries (#559)
965b4c2 
* docs: add 0.6.0 changelog entries

Groups new entries by: features, bug fixes, examples/docs, tests/maintenance.

Features: Cl() kingdon interface (#550, closes #524), Mv.__rtruediv__
(#543, closes #512), shirokov_inverse/hitzer_inverse (#530).

Bugs: interop dual mode contamination (#556, closes #555), norm() Abs
wrapping (#554, closes #522), is_versor() improvement (#536, closes #533).

Examples/docs: sundial + cheatsheet tests (#549+#557, closes #506),
coords tutorial (#551), README ops (#548, closes #523).

Tests/maintenance: lt.matrix() regression tests (#558, closes #461),
extra-cdot regression test (#545), er_blade + ReciprocalFrame refactors
(#552+#553), CI fix (#535).

* docs: add missing issue link for #551 entry

* docs: add changelog entry for #560 (Lt callable zero fix)

* docs: move Lt zero fix into bug group, use issue #540 as reference
utiberious added a commit to utiberious/galgebra that referenced this pull request Apr 2, 2026
@utiberious
docs: add 0.6.0 changelog entries (pygae#559)
9376474 
* docs: add 0.6.0 changelog entries

Groups new entries by: features, bug fixes, examples/docs, tests/maintenance.

Features: Cl() kingdon interface (pygae#550, closes pygae#524), Mv.__rtruediv__
(pygae#543, closes pygae#512), shirokov_inverse/hitzer_inverse (pygae#530).

Bugs: interop dual mode contamination (pygae#556, closes pygae#555), norm() Abs
wrapping (pygae#554, closes pygae#522), is_versor() improvement (pygae#536, closes pygae#533).

Examples/docs: sundial + cheatsheet tests (pygae#549+pygae#557, closes pygae#506),
coords tutorial (pygae#551), README ops (pygae#548, closes pygae#523).

Tests/maintenance: lt.matrix() regression tests (pygae#558, closes pygae#461),
extra-cdot regression test (pygae#545), er_blade + ReciprocalFrame refactors
(pygae#552+pygae#553), CI fix (pygae#535).

* docs: add missing issue link for pygae#551 entry

* docs: add changelog entry for pygae#560 (Lt callable zero fix)

* docs: move Lt zero fix into bug group, use issue pygae#540 as reference
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

component: docs Documentation state: needs changelog Needs a changelog entry before the next release. Remove this label when the changelog is done.

Projects

None yet

Milestone

0.6.0

Development

Successfully merging this pull request may close these issues.

Improve doc on available GA operations in README

2 participants

@utiberious @utensil