Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Style: Add Deprecation sub-section #604

Open
wants to merge 2 commits into
base: lean4
Choose a base branch
from

Conversation

vlad902
Copy link

@vlad902 vlad902 commented Mar 10, 2025

Copy link
Member

@jcommelin jcommelin left a comment

Choose a reason for hiding this comment

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

Thanks for documenting this!

Comment on lines +572 to +573
that rely on these definitions to fail to compile. Any publicly exposed theorem
definitions that are being changed should be gracefully transitioned by keeping the
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
that rely on these definitions to fail to compile. Any publicly exposed theorem
definitions that are being changed should be gracefully transitioned by keeping the
that rely on these definitions to fail to compile. Any publicly exposed theorem and
definitions that are being changed should be gracefully transitioned by keeping the

"change" is maybe a bit ambiguous: if I weaken an assumption? Or change an implicit variable to explicit, etc...

If the name doesn't change, it is also hard to use the deprecated attribute.

Copy link
Author

Choose a reason for hiding this comment

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

That's a good point. I've updated the wording to say:

Any publicly exposed theorems and definitions that are being removed should be ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants