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

chore: name variables in Data/BitVec consistently #4930

Conversation

tobiasgrosser
Copy link
Contributor

@tobiasgrosser tobiasgrosser commented Aug 6, 2024

This change canonicalizes the BitVec variable names to x y z : BitVec instead of alternative namings such as s t : BitVec or a b : BitVec. Variable names that carry semantic meaning such as (msbs : BitVec w) (lsb : Bool) remain untouched.

This is purely a naming change to make our bitvector proofs more consistent and polish the (auto-generated) documentation as a very small step towards polishing the documentation of the BitVec library in Lean.

This is purely a naming change to make our bitvector proofs more consistent.
@tobiasgrosser tobiasgrosser requested a review from kim-em as a code owner August 6, 2024 15:31
@tobiasgrosser tobiasgrosser marked this pull request as draft August 6, 2024 15:34
@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 Aug 6, 2024
@leanprover-community-mathlib4-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 35e1554ef7c3fb01bdf1989e311cc5dcdc5b417c --onto 647a5e94925791f6a16b629b6c16ffad60a7f478. (2024-08-06 17:07:33)

@AnotherAlexHere
Copy link
Contributor

This is purely a naming change to make our bitvector proofs more consistent and removes the last uses of i/j and similar simply enumerative variable names for BitVectors.

I think it may be helpful to explain the purpose of these changes and give examples.

@tobiasgrosser tobiasgrosser changed the title chore: use x/y consistently to name bitvectors chore: n to name bitvectors Aug 7, 2024
@tobiasgrosser tobiasgrosser changed the title chore: n to name bitvectors chore: Nm to name bitvectors Aug 7, 2024
@tobiasgrosser tobiasgrosser changed the title chore: Nm to name bitvectors chore: Name variables in Data/BitVec consistently Aug 7, 2024
@tobiasgrosser tobiasgrosser changed the title chore: Name variables in Data/BitVec consistently chore: name variables in Data/BitVec consistently Aug 7, 2024
@tobiasgrosser
Copy link
Contributor Author

This is purely a naming change to make our bitvector proofs more consistent and removes the last uses of i/j and similar simply enumerative variable names for BitVectors.

I think it may be helpful to explain the purpose of these changes and give examples.

I updated the commit message accordingly.

@kim-em
Copy link
Collaborator

kim-em commented Aug 7, 2024

Thanks! Happy to merge when you mark it as ready.

Copy link
Contributor

@AnotherAlexHere AnotherAlexHere left a comment

Choose a reason for hiding this comment

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

Looks good!

@tobiasgrosser tobiasgrosser marked this pull request as ready for review August 7, 2024 13:42
@hargoniX hargoniX added this pull request to the merge queue Aug 7, 2024
Merged via the queue into leanprover:master with commit 313f6b3 Aug 7, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

5 participants