Mention integers in mod1 docstring#41448
Merged
dkarrasch merged 2 commits intoJuliaLang:masterfrom Jul 4, 2021
Merged
Conversation
vtjnash
approved these changes
Jul 2, 2021
Co-authored-by: Jameson Nash <vtjnash@gmail.com>
johanmon
pushed a commit
to johanmon/julia
that referenced
this pull request
Jul 5, 2021
Co-authored-by: Jameson Nash <vtjnash@gmail.com>
simeonschaub
added a commit
that referenced
this pull request
Jul 6, 2021
This currently causes the whitespace check to fail.
Member
|
This seems to have accidentally added trailing whitespace. @staticfloat @DilumAluthge Any ideas what happened to the whitespace job? |
simeonschaub
added a commit
that referenced
this pull request
Jul 6, 2021
simeonschaub
added a commit
to goggle/julia
that referenced
this pull request
Jul 6, 2021
This currently causes the whitespace check to fail.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The present docstring for
mod1explains it as giving a result in the closed-right interval(0, y], instead of[0, y)formod. That's focused on the real numbers, but it's then a bit of a mystery why this is calledmod1. I think that comes from the integers, where it returns something in1:yinstead of in0:y-1, thus matchingOneTo(y). So I added a paragraph saying that.And I've extended the examples to, I hope, make them explain what it does even if you didn't read the formal version.