Skip to content

Incorrect documentation for realLorentzTensor in Basic.lean #1538

Description

@Alex-Zughaid

⚠️ Found by a local LLM, not a human. This was flagged by an automated documentation-mistake finder (qwen3:14b) and passed 10/10 independent verification runs before filing, but it has not been reviewed by a person. Please check it's a genuine error before acting on it.


Summary

The documentation in Physlib/Relativity/Tensors/RealTensor/Basic.lean (around line 67) is incorrect.

Current text

/-- The tensor structure for complex Lorentz tensors. -/

Why this is wrong

The docstring for realLorentzTensor incorrectly claims it defines "complex Lorentz tensors", but the declaration's name and surrounding context clearly indicate it is for real tensors. The file's comments explicitly mention "Real Lorentz tensors" and the definition uses Lorentz.ContrMod/Lorentz.CoMod, which are real vector spaces.

This discrepancy arises because the docstring was not updated when the definition was renamed from a complex variant to a real one. The correction aligns the documentation with the actual purpose of realLorentzTensor, which is consistent with the file's focus on real tensor structures and the use of ℝ as the scalar field in its type signature.

Suggested correction

/-- The tensor structure for real Lorentz tensors. -/

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions