Skip to content

docs: fix ContrMod docstring (real vectors, not complex) - #1585

Merged
jstoobysmith merged 1 commit into
leanprover-community:masterfrom
sankalpsthakur:docs/1508-contrmod-docstring
Aug 28, 2026
Merged

docs: fix ContrMod docstring (real vectors, not complex)#1585
jstoobysmith merged 1 commit into
leanprover-community:masterfrom
sankalpsthakur:docs/1508-contrmod-docstring

Conversation

@sankalpsthakur

@sankalpsthakur sankalpsthakur commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Summary

toFin1dℝFun was documented as an equivalence between ContrℝModule and complex-valued functions. The type is ContrMod d ≃ (Fin 1 ⊕ Fin d → ℝ). Update that docstring and the other stale ContrℝModule names in this file.

Validation

  • Doc comments now match ContrMod and in Physlib/Relativity/Tensors/RealTensor/Vector/Pre/Modules.lean.

Fixes #1508

AI/LLM disclosure

  • AI coding tools (including Grok and/or Codex agent-assisted editing) were used to help draft or modify code and this PR description.
  • I reviewed the complete change, understand the reasoning, and ran the reported local tests before submitting.
  • This submission is original work of authorship under the project CLA / contributor terms; AI output was not pasted unreviewed.

@github-actions github-actions Bot added the small label Aug 28, 2026
@github-actions

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 Aug 28, 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 - many thanks for this fix.

@jstoobysmith jstoobysmith added the ready-to-merge This PR is approved and will be merged shortly label Aug 28, 2026
@jstoobysmith
jstoobysmith merged commit 73977f6 into leanprover-community:master Aug 28, 2026
9 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.

Comment claims equivalence between ContrℝModule and complex-valued vectors

2 participants