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

doc: describe all simp configuration options #3870

Merged
merged 2 commits into from
Apr 12, 2024

Conversation

kmill
Copy link
Collaborator

@kmill kmill commented Apr 10, 2024

Co-authored by Marc Huisinga, with input from Leo.

Co-authored by Marc Huisinga, with input from Leo.
@kmill kmill added the documentation Documentation improvement label Apr 10, 2024
@github-actions github-actions bot added the toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN label Apr 10, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Apr 10, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Apr 10, 2024
src/Init/MetaTypes.lean Outdated Show resolved Hide resolved
@digama0
Copy link
Collaborator

digama0 commented Apr 10, 2024

It will probably be a lot more work than what you have already done here (thank you all for this BTW!), but it would also be useful to have examples where a user might plausibly want to turn on each option and demonstrate the difference, because the specification of the flags can be somewhat opaque if you don't know simp / type theory internals.

@leanprover-community-mathlib4-bot leanprover-community-mathlib4-bot added the builds-mathlib CI has verified that Mathlib builds against this PR label Apr 10, 2024
@leanprover-community-mathlib4-bot
Copy link
Collaborator

leanprover-community-mathlib4-bot commented Apr 10, 2024

Mathlib CI status (docs):

leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Apr 10, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Apr 10, 2024
@kmill
Copy link
Collaborator Author

kmill commented Apr 11, 2024

@digama0 Thanks for taking a look. Regarding giving examples, I agree that they should appear somewhere. At the least, we can finally port that mathlib simp document now that we know what the simp options are, but I think eventually the plan is to have this be part of the Lean reference documentation.

leanprover-community-mathlib4-bot added a commit to leanprover-community/batteries that referenced this pull request Apr 11, 2024
leanprover-community-mathlib4-bot added a commit to leanprover-community/mathlib4 that referenced this pull request Apr 11, 2024
@david-christiansen
Copy link
Contributor

Yes, the examples definitely needs to be in the new reference! In the meantime, I think it's useful to have them here "below the fold", but it's OK not to as well.

Copy link
Contributor

@david-christiansen david-christiansen left a comment

Choose a reason for hiding this comment

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

This is a very nicely written set of docs!

@kmill kmill added this pull request to the merge queue Apr 12, 2024
Merged via the queue into leanprover:master with commit e59fad2 Apr 12, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
builds-mathlib CI has verified that Mathlib builds against this PR documentation Documentation improvement toolchain-available A toolchain is available for this PR, at leanprover/lean4-pr-releases:pr-release-NNNN
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants