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: add recommended spellings for many term notations #6886

Merged
merged 4 commits into from
Feb 3, 2025

Conversation

TwoFX
Copy link
Member

@TwoFX TwoFX commented Jan 31, 2025

This PR adds recommended spellings for many notations defined in Lean core, using the recommended_spelling command from #6869.

@TwoFX TwoFX added the changelog-doc Documentation label Jan 31, 2025
@TwoFX TwoFX force-pushed the markus/recommended-spellings branch from c02405c to 80f76d4 Compare February 1, 2025 06:44
@TwoFX TwoFX force-pushed the markus/recommended-spellings branch from 80f76d4 to 23e0105 Compare February 3, 2025 12:51
@TwoFX TwoFX marked this pull request as ready for review February 3, 2025 12:52
@TwoFX TwoFX requested a review from kim-em as a code owner February 3, 2025 12:52
@TwoFX TwoFX enabled auto-merge February 3, 2025 12:52
@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 Feb 3, 2025
@leanprover-community-bot
Copy link
Collaborator

Mathlib CI status (docs):

  • ❗ Batteries/Mathlib CI will not be attempted unless your PR branches off the nightly-with-mathlib branch. Try git rebase 5930f430f44d95600f1aff1f26b10e87c67d7d14 --onto 832d7c500d709deb5e7f0a5a6fd0f01865d1a303. (2025-02-03 13:19:59)

@github-actions github-actions bot temporarily deployed to lean-lang.org/lean4/doc February 3, 2025 13:41 Inactive
@TwoFX TwoFX added this pull request to the merge queue Feb 3, 2025
Merged via the queue into master with commit ffa1e9e Feb 3, 2025
15 checks passed
Comment on lines +1007 to +1008
/-- not `isSuffix` -/
recommended_spelling "suffix" for "<:+" in [IsSuffix, «term_<:+_»]

Choose a reason for hiding this comment

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

This goes against the community naming convention. Will there be a discussion about recommended spellings?

Copy link
Member Author

Choose a reason for hiding this comment

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

Does it? There seems to be barely anything in mathlib about List.IsSuffix. https://loogle.lean-lang.org/?q=List.IsSuffix

Copy link
Member Author

Choose a reason for hiding this comment

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

More generally, I have made an attempt to always use the established naming. If you think I made a mistake somewhere, feel free to note it here or start a thread on Zulip about specific spellings.

Choose a reason for hiding this comment

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

suffix is the current name, but it goes against the naming convention (which would instead be isSuffix). I am worried that this recommended_spelling will turn the statu quo into an official recommendation.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think it is a problem if a notation has a different name than the declaration it refers to. For example, we say singleton for [x] and not something like consNil.

luisacicolini pushed a commit to opencompl/lean4 that referenced this pull request Feb 24, 2025
This PR adds recommended spellings for many notations defined in Lean
core, using the `recommended_spelling` command from leanprover#6869.
luisacicolini pushed a commit to opencompl/lean4 that referenced this pull request Feb 25, 2025
This PR adds recommended spellings for many notations defined in Lean
core, using the `recommended_spelling` command from leanprover#6869.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-doc Documentation 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.

3 participants