Skip to content

doc(Relativity): Correct documentation for realLorentzTensor - #1712

Merged
jstoobysmith merged 3 commits into
leanprover-community:masterfrom
ereinhardt8:realtensor-doc-issues
Oct 2, 2026
Merged

jstoobysmith merged 3 commits into
leanprover-community:masterfrom
ereinhardt8:realtensor-doc-issues

Conversation

@ereinhardt8

Copy link
Copy Markdown
Contributor

This pull request fixes issues #1532 and #1538 by replacing occurrences of "complex" with "real" within doc-comments in Physlib/Relativity/Tensors/RealTensor/Basic.lean and Physlib/Relativity/Tensors/RealTensor/Metrics/Basic.lean.

Reviewer Guide

Quick question: Is SO⁺(1, 3) the correct group to use at line 28 of Physlib/Relativity/Tensors/RealTensor/Basic.lean? Or would O(1, 3) be better? (I do not know quite enough about Lie groups.)

Thank you!

@github-actions github-actions Bot added the small label Oct 2, 2026
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Thank you for this pull-request (PR). If this is your first PR, welcome to the community!

Below is what will happen next. Please read carefully if you are not familiar with the process. You may open other PRs while this one is being reviewed, and can stack PRs on top of each other, so don't let these steps slow you down.

  1. Some automated checks will be run on your PR. You can see the results of these checks at the buttom of your PR page. If any of these checks fail, you will need to fix the issues before your PR can be merged. You can learn more about these here, including how to run them locally, which is sometimes quicker than relying on the GitHub Actions. If you have never had a PR merged before, you may have to wait for a reviewer to manually start these checks (this is for security).

  2. A reviewer will look at your PR and may ask you to make changes. This may happen a couple of days after you submit your PR, so you may need to be patient. But it should not be longer than that - if it is please bring it to the attention of the community on the Zulip. The level of review will depend on where your PR is submitted. If it is submitted to ./Physlib or ./QuantumInfo, the review will be more thorough than if it is submitted to ./PhyslibAlpha. You can find out more about what the review process is looking for in our review guidelines. If a reviewer adds an awaiting-author label to your PR, address the review comments, then please remove that label by adding a comment with -awaiting-author. This helps us keep track of reviews.

  3. The reviewer will either approve your PR, or request more changes (in which case we return to step 2). Once your PR is approved, it will be merged by a maintainer, this should happen shortly after approval, though you may get more comments at this stage.

Tip: The easiest way to get have a fast review is to submit a PR that is small and self-contained, and has clear documentation explaining why things are the way they are in your chages.

If you have any problems or questions, please reach out to the community on the Zulip.

@github-actions github-actions Bot added the t-relativity Relativity label Oct 2, 2026
@jstoobysmith

Copy link
Copy Markdown
Member

@ereinhardt8 Good question, in this case it is the full Lorentz group, so should be O(1, 3).

(Btw the build errors here are not yours so no need to fix them.)

@jstoobysmith jstoobysmith left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One comment, related to the question.

Comment thread Physlib/Relativity/Tensors/RealTensor/Basic.lean Outdated
@jstoobysmith

Copy link
Copy Markdown
Member

awaiting-author

@github-actions github-actions Bot added the awaiting-author A reviewer has asked the author a question or requested changes label Oct 2, 2026
Co-authored-by: Joseph Tooby-Smith <72603918+jstoobysmith@users.noreply.github.com>
@ereinhardt8

Copy link
Copy Markdown
Contributor Author

-awaiting-author

@github-actions github-actions Bot removed the awaiting-author A reviewer has asked the author a question or requested changes label Oct 2, 2026

@jstoobysmith jstoobysmith left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved - will merge now. Many thanks.

@jstoobysmith jstoobysmith added the ready-to-merge This PR is approved and will be merged shortly label Oct 2, 2026
@jstoobysmith
jstoobysmith added this pull request to the merge queue Oct 2, 2026
Merged via the queue into leanprover-community:master with commit 00849d2 Oct 2, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-to-merge This PR is approved and will be merged shortly small t-relativity Relativity

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants