mathlib4 icon indicating copy to clipboard operation
mathlib4 copied to clipboard

rename: `no_lost_declarations` to `decls_diff` and `short` as default option

Open adomani opened this issue 1 year ago • 1 comments

This PR renames the no_lost_declarations script to decls_diff, to better describe the effect of the script. It was originally intended as a script to make sure that "moving" PRs did not leave out any declaration, but is now used as a measure of the diff in declarations between PRs and master.

The other change it does is to make the short option the default, as this is the most commonly used.

Old New
./scripts/no_lost_declarations.sh short ./scripts/decls_diff.sh
./scripts/no_lost_declarations.sh ./scripts/decls_diff.sh long

Mostly, these changes are invisible, as this script is used almost exclusively by CI, but the intention is that the change conveys better what script does to a human.


Open in Gitpod

adomani avatar Jun 24 '24 21:06 adomani

PR summary 01cceba7e3

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>

github-actions[bot] avatar Jun 24 '24 21:06 github-actions[bot]

Looks reasonable! What do you think about renaming to declarations_diff? (I find the latter more readable; if mostly CI runs this, one might as well use a readable name.) Feel free to maintainer merge on my behalf when you considered this.

grunweg avatar Jul 11 '24 16:07 grunweg

Michael, thank you for the suggestion: I like it and I renamed the script to declarations_diff.

adomani avatar Jul 11 '24 18:07 adomani

Thanks! maintainer merge

grunweg avatar Jul 11 '24 19:07 grunweg

🚀 Pull request has been placed on the maintainer queue by grunweg.

github-actions[bot] avatar Jul 11 '24 19:07 github-actions[bot]

bors merge

mattrobball avatar Jul 11 '24 19:07 mattrobball

Pull request successfully merged into master.

Build succeeded:

mathlib-bors[bot] avatar Jul 11 '24 19:07 mathlib-bors[bot]