Skip to content

[Merged by Bors] - chore: unify date formatting in lemma deprecations#12334

Closed
grunweg wants to merge 6 commits intomasterfrom
MR-deprecated-lemma-date-format
Closed

[Merged by Bors] - chore: unify date formatting in lemma deprecations#12334
grunweg wants to merge 6 commits intomasterfrom
MR-deprecated-lemma-date-format

Conversation

@grunweg
Copy link
Copy Markdown
Contributor

@grunweg grunweg commented Apr 22, 2024

  • consistently use the YYYY-MM-DD format
  • when easily possible, put the date on the same line as the deprecated attribute
  • when easily possible, format the entire declaration on the same line

Why these changes?

  • consistency makes it easier for tools to parse this information
  • compactness: I don't see a good reason for these declarations taking up more space than needed;
    as I understand it, deprecated lemmas are not supposed to be used in mathlib anyway
  • putting the date on the same line as the attribute makes it easier to discover un-dated deprecations;
    they also ease writing a tool to replace these by a machine-readable version using feat: improve @[deprecated] attr leanprover/lean4#3968

All commits can be reviewed individually.
#12335 has a similar change (just formatting things on one line), which I pulled out since that is fairly large.


Open in Gitpod

@grunweg grunweg added awaiting-review tech debt Tracking cross-cutting technical debt, see e.g. the "Technical debt counters" stream on zulip labels Apr 22, 2024
@kim-em
Copy link
Copy Markdown
Contributor

kim-em commented Apr 24, 2024

bors merge

@github-actions github-actions bot added ready-to-merge This PR has been sent to bors. and removed awaiting-review labels Apr 24, 2024
mathlib-bors bot pushed a commit that referenced this pull request Apr 24, 2024
- consistently use the YYYY-MM-DD format
- when easily possible, put the date on the same line as the `deprecated` attribute
- when easily possible, format the entire declaration on the same line

Why these changes?
- consistency makes it easier for tools to parse this information
- compactness: I don't see a good reason for these declarations taking up more space than needed;
 as I understand it, deprecated lemmas are not supposed to be used in mathlib anyway
- putting the date on the same line as the attribute makes it easier to discover un-dated deprecations;
they also ease writing a tool to replace these by a machine-readable version using leanprover/lean4#3968
@mathlib-bors
Copy link
Copy Markdown
Contributor

mathlib-bors bot commented Apr 24, 2024

Pull request successfully merged into master.

Build succeeded:

@mathlib-bors mathlib-bors bot changed the title chore: unify date formatting in lemma deprecations [Merged by Bors] - chore: unify date formatting in lemma deprecations Apr 24, 2024
@mathlib-bors mathlib-bors bot closed this Apr 24, 2024
@mathlib-bors mathlib-bors bot deleted the MR-deprecated-lemma-date-format branch April 24, 2024 06:52
@grunweg
Copy link
Copy Markdown
Contributor Author

grunweg commented Apr 24, 2024

Thanks for the fast review!

Jun2M pushed a commit that referenced this pull request Apr 24, 2024
- consistently use the YYYY-MM-DD format
- when easily possible, put the date on the same line as the `deprecated` attribute
- when easily possible, format the entire declaration on the same line

Why these changes?
- consistency makes it easier for tools to parse this information
- compactness: I don't see a good reason for these declarations taking up more space than needed;
 as I understand it, deprecated lemmas are not supposed to be used in mathlib anyway
- putting the date on the same line as the attribute makes it easier to discover un-dated deprecations;
they also ease writing a tool to replace these by a machine-readable version using leanprover/lean4#3968
callesonne pushed a commit that referenced this pull request May 16, 2024
- consistently use the YYYY-MM-DD format
- when easily possible, put the date on the same line as the `deprecated` attribute
- when easily possible, format the entire declaration on the same line

Why these changes?
- consistency makes it easier for tools to parse this information
- compactness: I don't see a good reason for these declarations taking up more space than needed;
 as I understand it, deprecated lemmas are not supposed to be used in mathlib anyway
- putting the date on the same line as the attribute makes it easier to discover un-dated deprecations;
they also ease writing a tool to replace these by a machine-readable version using leanprover/lean4#3968
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-to-merge This PR has been sent to bors. tech debt Tracking cross-cutting technical debt, see e.g. the "Technical debt counters" stream on zulip

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants