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: update documentation and tests for toUIntX functions #5497

Merged
merged 1 commit into from
Sep 29, 2024

Conversation

TomasPuverle
Copy link
Contributor

Update documentation on functions to reflect actual behavior.
Add tests to ensure said behavior is as documented.

Closes #5483

@TomasPuverle
Copy link
Contributor Author

CC: @david-christiansen since I noticed most people ask you for documentation/wording review for PRs.

@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 Sep 27, 2024
@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 56b78a0ed104c896c033bcd2284449cea2dd5d12 --onto 0196bca784f82f90b4efd2a85a400daf4ab767f8. (2024-09-27 17:25:53)

@kim-em kim-em added this pull request to the merge queue Sep 29, 2024
Merged via the queue into leanprover:master with commit 994cfa4 Sep 29, 2024
13 checks passed
@david-christiansen
Copy link
Contributor

Thanks for the ping! I was off away from the Internet for a few days. Other than marking code with backticks, I think the text is great :)

@david-christiansen
Copy link
Contributor

(and the presence of tests even greater)

github-merge-queue bot pushed a commit that referenced this pull request Sep 30, 2024
Minor docstrings tweaks on the basis of #5497
@TomasPuverle
Copy link
Contributor Author

Thanks! I'll know to use backticks in the future.

As for the tests, I considered moving them to the format using #guard_msg but thought perhaps that was too big of a change for just a doc update. However, is it the general intention for all tests to be ported to the new "standard"?

@TomasPuverle TomasPuverle deleted the float_docs branch October 1, 2024 04:12
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.

The conversion of Float to UInt64 doesn't behave as described in the documentation.
4 participants