leanprover-community / leanprover-community/physlib

Incorrect documentation for Galilean action on space in `actSpace`

Open Beginner friendly
#1,530 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue help-wanted
Dominant language
Lean
Stars
750
Forks
191
Avg merge
1d 21h
Merged PRs (30d)
75

Description

⚠️ 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/SpaceAndTime/GalileanGroup/Basic.lean (around line 161) is incorrect.

Current text
-- The Galilean action on space at a fixed time.
Why this is wrong

The docstring for actSpace claims the Galilean action operates "on space at a fixed time," but this is incorrect. The function actSpace explicitly takes a t : Time parameter, indicating the transformation depends on the specified time. This aligns with the active convention (t, x) ↦ (t + b, R x + v t + a) defined in the module's documentation.

The error arises because the docstring contradicts the function's actual implementation, which uses t to compute the spatial component of the transformation. The correction accurately reflects that the action depends on the provided time parameter t, as seen in the definition of actSpace. This ensures the documentation matches the mathematical behavior of Galilean transformations.

Suggested correction
-- The Galilean action on space, which depends on the given time `t`.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open Physlib/SpaceAndTime/GalileanGroup/Basic.lean around line 161 and inspect the actSpace definition alongside its docstring. Confirm how the given time parameter affects the spatial action, then update the documentation so it matches that behavior. Done when the docstring no longer says the action is at a fixed time.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
82/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.