Skip to content

chore: add missing to_additive docstrings in Combinatorics and Dynamics#41645

Open
adomani wants to merge 3 commits into
leanprover-community:masterfrom
adomani:to_additive-docs-combinatorics-dynamics
Open

chore: add missing to_additive docstrings in Combinatorics and Dynamics#41645
adomani wants to merge 3 commits into
leanprover-community:masterfrom
adomani:to_additive-docs-combinatorics-dynamics

Conversation

@adomani

@adomani adomani commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

Adds the missing additive doc-strings (multiplicative side has a hand-written doc-string, additive side did not) across 5 file(s) in Combinatorics and Dynamics.

The additive doc-strings are simple-minded translations of the multiplicative ones, with referenced lemma names replaced by their to_additive counterparts. These gaps were found by an environment linter that pairs each declaration with its to_additive counterpart and checks that both or neither is documented.

🤖 Generated with Claude Code

…mics

For each declaration in these files that carries a hand-written doc-string
but whose `to_additive` counterpart was missing one, this adds the additive
doc-string (a simple-minded multiplicative-to-additive translation, with
referenced lemma names translated to their additive versions).

Part of a split of the `to_additive` doc-string sweep into reviewable chunks.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@adomani adomani added the LLM-generated PRs with substantial input from LLMs - review accordingly label Jul 12, 2026
@github-actions

github-actions Bot commented Jul 12, 2026

Copy link
Copy Markdown

PR summary c44884d54e

Import changes for modified files

No significant changes to the import graph

Import changes for all files
Files Import difference

Declarations diff (regex)

No declarations were harmed in the making of this PR! 🐙

You can run this locally as follows
## from your `mathlib4` directory:
git clone https://github.com/leanprover-community/mathlib-ci.git ../mathlib-ci

## summary with just the declaration names:
../mathlib-ci/scripts/pr_summary/declarations_diff.sh <optional_commit>

## more verbose report:
../mathlib-ci/scripts/pr_summary/declarations_diff.sh long <optional_commit>

The doc-module for scripts/pr_summary/declarations_diff.sh in the mathlib-ci repository contains some details about this script.

Declarations diff (Lean -- pending)

Computed after the build finishes.


No changes to strong technical debt.

No changes to weak technical debt.

Current commit c44884d54e
Reference commit 79aee35d96

This script lives in the mathlib-ci repository. To run it locally, from your mathlib4 directory:

git clone https://github.com/leanprover-community/mathlib-ci.git ../mathlib-ci
../mathlib-ci/scripts/reporting/technical-debt-metrics.sh pr_summary
  • The relative value is the weighted sum of the differences with weight given by the inverse of the current value of the statistic.
  • The absolute value is the relative value divided by the total sum of the inverses of the current values (i.e. the weighted average of the differences).

Comment thread Mathlib/Combinatorics/Additive/FreimanHom.lean Outdated
Comment thread Mathlib/Combinatorics/Additive/FreimanHom.lean Outdated
Co-authored-by: Bhavik Mehta <bhavikmehta8@gmail.com>
@adomani adomani marked this pull request as ready for review July 13, 2026 13:06
Rebalance the additive `IsAddFreimanIso.symm` doc-string across two lines to
satisfy the 100-character long-line lint.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

LLM-generated PRs with substantial input from LLMs - review accordingly

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants