Skip to content

[Merged by Bors] - chore(SimpleGraph/Extremal): update IsExtremal docstrings#31372

Closed
mitchell-horner wants to merge 1 commit into
leanprover-community:masterfrom
mitchell-horner:is-extremal-docstring
Closed

[Merged by Bors] - chore(SimpleGraph/Extremal): update IsExtremal docstrings#31372
mitchell-horner wants to merge 1 commit into
leanprover-community:masterfrom
mitchell-horner:is-extremal-docstring

Conversation

@mitchell-horner

Copy link
Copy Markdown
Collaborator

Update docstrings for IsExtremal to clarify definition.


Open in Gitpod

See #28719 (comment).

The docstring left out the fact that the maximum is taken on simple graphs with fixed vertices. This is implicit in the definition of SimpleGraph. The docstring now explicitly notes this to avoid confusion and align with the definition you might read in a textbook somewhere.

@mitchell-horner mitchell-horner added easy < 20s of review time. See the lifecycle page for guidelines. t-combinatorics Combinatorics labels Nov 8, 2025
@github-actions

github-actions Bot commented Nov 8, 2025

Copy link
Copy Markdown

PR summary ec382b5a79

Import changes for modified files

No significant changes to the import graph

Import changes for all files
Files Import difference

Declarations diff

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

You can run this locally as follows
## summary with just the declaration names:
./scripts/declarations_diff.sh <optional_commit>

## more verbose report:
./scripts/declarations_diff.sh long <optional_commit>

The doc-module for script/declarations_diff.sh contains some details about this script.


No changes to technical debt.

You can run this locally as

./scripts/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).

@vihdzp vihdzp left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@b-mehta b-mehta left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

bors merge

mathlib-bors Bot pushed a commit that referenced this pull request Nov 8, 2025
Update docstrings for `IsExtremal` to clarify definition.
@ghost ghost added the ready-to-merge This PR has been sent to bors. label Nov 8, 2025
@mathlib-bors

mathlib-bors Bot commented Nov 8, 2025

Copy link
Copy Markdown
Contributor

Pull request successfully merged into master.

Build succeeded:

@mathlib-bors mathlib-bors Bot changed the title chore(SimpleGraph/Extremal): update IsExtremal docstrings [Merged by Bors] - chore(SimpleGraph/Extremal): update IsExtremal docstrings Nov 8, 2025
@mathlib-bors mathlib-bors Bot closed this Nov 8, 2025
thorimur pushed a commit to thorimur/mathlib4 that referenced this pull request Nov 16, 2025
…er-community#31372)

Update docstrings for `IsExtremal` to clarify definition.
@mitchell-horner mitchell-horner deleted the is-extremal-docstring branch January 7, 2026 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

easy < 20s of review time. See the lifecycle page for guidelines. ready-to-merge This PR has been sent to bors. t-combinatorics Combinatorics

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants