Skip to content

feat: check indentation of doc-strings, basic version#27898

Closed
grunweg wants to merge 41 commits into
leanprover-community:masterfrom
grunweg:docstring-indent-basic
Closed

feat: check indentation of doc-strings, basic version#27898
grunweg wants to merge 41 commits into
leanprover-community:masterfrom
grunweg:docstring-indent-basic

Conversation

@grunweg
Copy link
Copy Markdown
Contributor

@grunweg grunweg commented Aug 3, 2025

Basic version of #27897 (which still has some false positives): let's land this before weeding out the other errors.


Open in Gitpod

@grunweg grunweg added awaiting-CI This PR does not pass CI yet. This label is automatically removed once it does. t-linter Linter labels Aug 3, 2025
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Aug 3, 2025

PR summary 218e764a49

Import changes for modified files

No significant changes to the import graph

Import changes for all files
Files Import difference

Declarations diff

+ checkFormatting

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

@grunweg grunweg force-pushed the docstring-indent-basic branch from 30378b8 to 5deeb53 Compare August 3, 2025 15:09
@grunweg grunweg force-pushed the docstring-indent-basic branch from f596272 to 51d0ebe Compare August 5, 2025 21:04
@mathlib4-dependent-issues-bot mathlib4-dependent-issues-bot added the blocked-by-other-PR This PR depends on another PR (this label is automatically managed by a bot) label Aug 5, 2025
@mathlib4-dependent-issues-bot
Copy link
Copy Markdown
Collaborator

mathlib4-dependent-issues-bot commented Aug 5, 2025

@github-actions github-actions Bot removed the awaiting-CI This PR does not pass CI yet. This label is automatically removed once it does. label Aug 5, 2025
@mathlib4-merge-conflict-bot mathlib4-merge-conflict-bot added the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Aug 6, 2025
@mathlib4-merge-conflict-bot
Copy link
Copy Markdown
Collaborator

This pull request has conflicts, please merge master and resolve them.

@github-actions github-actions Bot removed the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Aug 6, 2025
mathlib-bors Bot pushed a commit that referenced this pull request Aug 7, 2025
This is rendered better on the generated documentation, and indicates that this code has different formatting rules.

Found by the linter in #27898.
staroperator pushed a commit to staroperator/mathlib4 that referenced this pull request Aug 8, 2025
…nity#27901)

This is rendered better on the generated documentation, and indicates that this code has different formatting rules.

Found by the linter in leanprover-community#27898.
@mathlib4-merge-conflict-bot mathlib4-merge-conflict-bot added the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Aug 8, 2025
@mathlib4-merge-conflict-bot
Copy link
Copy Markdown
Collaborator

This pull request has conflicts, please merge master and resolve them.

@github-actions github-actions Bot removed the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Aug 8, 2025
@mathlib4-merge-conflict-bot mathlib4-merge-conflict-bot added the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Aug 14, 2025
@mathlib4-merge-conflict-bot
Copy link
Copy Markdown
Collaborator

This pull request has conflicts, please merge master and resolve them.

@github-actions github-actions Bot removed the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Aug 14, 2025
Paul-Lez pushed a commit to Paul-Lez/mathlib4 that referenced this pull request Aug 23, 2025
…nity#27901)

This is rendered better on the generated documentation, and indicates that this code has different formatting rules.

Found by the linter in leanprover-community#27898.
Paul-Lez pushed a commit to Paul-Lez/mathlib4 that referenced this pull request Aug 23, 2025
…nity#27901)

This is rendered better on the generated documentation, and indicates that this code has different formatting rules.

Found by the linter in leanprover-community#27898.
@mathlib4-merge-conflict-bot mathlib4-merge-conflict-bot added the merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) label Sep 1, 2025
@mathlib4-merge-conflict-bot
Copy link
Copy Markdown
Collaborator

This pull request has conflicts, please merge master and resolve them.

@grunweg
Copy link
Copy Markdown
Contributor Author

grunweg commented Feb 15, 2026

Let's close this in favour of #27897, and re-do the doc-string fixes again.

@grunweg grunweg closed this Feb 15, 2026
@grunweg grunweg deleted the docstring-indent-basic branch February 15, 2026 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blocked-by-other-PR This PR depends on another PR (this label is automatically managed by a bot) merge-conflict The PR has a merge conflict with master, and needs manual merging. (this label is managed by a bot) t-linter Linter

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants