Fixes #40134: correct signs in inner_product_matrix docstring #40184
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jun 8, 2025
sagemathgh-40184: Fixes sagemath#40134: correct signs in inner_product_matrix docstring <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> Fixes [sagemath#40134](sagemath#40134). This PR corrects the explanatory text in the docstring of `QuaternionAlgebra.inner_product_matrix`. The original docstring claimed that the inner product matrix has diagonal entries `2`, `2a`, `2b`, `2ab` in the standard basis $1, i, j, k$. However, this contradicts both the actual implementation and the mathematical definition of the inner product used in the code, which should be, instead, `2`, `-2a`, `-2b`, `2ab`. This PR updates the docstring to reflect this, fixing the incorrect signs. All doctests in `src/sage/algebras/quaternion_algebra.py` pass. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [x] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#40184 Reported by: Aolong Li Reviewer(s): Travis Scrimshaw
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jun 9, 2025
sagemathgh-40184: Fixes sagemath#40134: correct signs in inner_product_matrix docstring <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> Fixes [sagemath#40134](sagemath#40134). This PR corrects the explanatory text in the docstring of `QuaternionAlgebra.inner_product_matrix`. The original docstring claimed that the inner product matrix has diagonal entries `2`, `2a`, `2b`, `2ab` in the standard basis $1, i, j, k$. However, this contradicts both the actual implementation and the mathematical definition of the inner product used in the code, which should be, instead, `2`, `-2a`, `-2b`, `2ab`. This PR updates the docstring to reflect this, fixing the incorrect signs. All doctests in `src/sage/algebras/quaternion_algebra.py` pass. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [x] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#40184 Reported by: Aolong Li Reviewer(s): Travis Scrimshaw
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jun 9, 2025
sagemathgh-40184: Fixes sagemath#40134: correct signs in inner_product_matrix docstring <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> Fixes [sagemath#40134](sagemath#40134). This PR corrects the explanatory text in the docstring of `QuaternionAlgebra.inner_product_matrix`. The original docstring claimed that the inner product matrix has diagonal entries `2`, `2a`, `2b`, `2ab` in the standard basis $1, i, j, k$. However, this contradicts both the actual implementation and the mathematical definition of the inner product used in the code, which should be, instead, `2`, `-2a`, `-2b`, `2ab`. This PR updates the docstring to reflect this, fixing the incorrect signs. All doctests in `src/sage/algebras/quaternion_algebra.py` pass. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [x] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#40184 Reported by: Aolong Li Reviewer(s): Travis Scrimshaw
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Jun 9, 2025
sagemathgh-40184: Fixes sagemath#40134: correct signs in inner_product_matrix docstring <!-- ^ Please provide a concise and informative title. --> <!-- ^ Don't put issue numbers in the title, do this in the PR description below. --> <!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method to calculate 1 + 2". --> <!-- v Describe your changes below in detail. --> <!-- v Why is this change required? What problem does it solve? --> <!-- v If this PR resolves an open issue, please link to it here. For example, "Fixes sagemath#12345". --> Fixes [sagemath#40134](sagemath#40134). This PR corrects the explanatory text in the docstring of `QuaternionAlgebra.inner_product_matrix`. The original docstring claimed that the inner product matrix has diagonal entries `2`, `2a`, `2b`, `2ab` in the standard basis $1, i, j, k$. However, this contradicts both the actual implementation and the mathematical definition of the inner product used in the code, which should be, instead, `2`, `-2a`, `-2b`, `2ab`. This PR updates the docstring to reflect this, fixing the incorrect signs. All doctests in `src/sage/algebras/quaternion_algebra.py` pass. ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [x] I have updated the documentation and checked the documentation preview. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on. For example, --> <!-- - sagemath#12345: short description why this is a dependency --> <!-- - sagemath#34567: ... --> URL: sagemath#40184 Reported by: Aolong Li Reviewer(s): Travis Scrimshaw
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #40134. This PR corrects the explanatory text in the docstring of
QuaternionAlgebra.inner_product_matrix.The original docstring claimed that the inner product matrix has diagonal entries$1, i, j, k$ . However, this contradicts both the actual implementation and the mathematical definition of the inner product used in the code, which should be, instead,
2,2a,2b,2abin the standard basis2,-2a,-2b,2ab.This PR updates the docstring to reflect this, fixing the incorrect signs. All doctests in
src/sage/algebras/quaternion_algebra.pypass.📝 Checklist
⌛ Dependencies