leanprover-community / leanprover-community/physlib

Module docstring incorrectly claims coverage of α-Renyi entropy

Open Beginner friendly
#1,536 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 QuantumInfo/Entropy/Axiomatized/Renyi.lean (around line 10) is incorrect.

Current text
/-! # Quantum Relative Entropy and α-Renyi Entropy -/
Why this is wrong

The module docstring for physlib/QuantumInfo/Entropy/Axiomatized/Renyi.lean states that the file covers both quantum relative entropy and α-Rényi entropy. However, the file only contains definitions and theorems related to quantum relative entropy via the declaration qRelativeEnt, with no mention of α-Rényi entropy anywhere in the code.

This discrepancy is incorrect because the code does not define or reference any α-Rényi entropy constructs. The correction removes the false claim about α-Rényi entropy, aligning the documentation with the actual content of the file. The remaining text accurately describes the sole focus on quantum relative entropy, as evidenced by the qRelativeEnt definition and associated theorems.

Suggested correction
/-! # Quantum Relative Entropy -/

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 QuantumInfo/Entropy/Axiomatized/Renyi.lean around line 10 and compare the module docstring with the file's qRelativeEnt-related content. Update the heading so it describes only quantum relative entropy, then verify that the α-Rényi entropy claim is gone.

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
90/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.