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

Docstring for Int.mod is misleading #5204

Closed
3 tasks done
TwoFX opened this issue Aug 29, 2024 · 0 comments · Fixed by #5230
Closed
3 tasks done

Docstring for Int.mod is misleading #5204

TwoFX opened this issue Aug 29, 2024 · 0 comments · Fixed by #5230
Labels
bug Something isn't working documentation Documentation improvement P-high We will work on this issue

Comments

@TwoFX
Copy link
Member

TwoFX commented Aug 29, 2024

Prerequisites

Please put an X between the brackets as you perform the following steps:

Description

The docstring for Int.mod (permalink) contains some nice examples which document the behavior of the % operator. Unfortunately, % on Int is actually Int.emod, and so the examples actually explain a different function.

Steps to Reproduce

  1. Click the link above

Expected behavior: Docstring documents the function

Actual behavior: Docstring documents a different function.

Versions

e1cbae2

Impact

Add 👍 to issues you consider important. If others are impacted by this issue, please ask them to add 👍 to it.

@TwoFX TwoFX added bug Something isn't working documentation Documentation improvement labels Aug 29, 2024
@leanprover-bot leanprover-bot added the P-high We will work on this issue label Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Documentation improvement P-high We will work on this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants