Minor docs correction for maxintfloat. #29301
Merged
Conversation
This file contains 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
Fixes JuliaLang#29297, see discussion there.
stevengj
reviewed
Sep 21, 2018
base/floatfuncs.jl
Outdated
| That is, `maxintfloat` returns the smallest positive integer-valued floating point number | ||
| `n` such that `n+1` is *not* exactly representable in the type `T`. | ||
|
|
||
| When an integer is needed, use `Integer(maxintfloat(T))`. |
There was a problem hiding this comment.
When an integer type is needed
There was a problem hiding this comment.
I am not sure I understand, as Integer(maxintfloat(T)) will return an integer (value), not a type.
There was a problem hiding this comment.
“Integer-typed value”?
There was a problem hiding this comment.
The point is that maxintfloat(T) returns an integer already (1.0 is an integer), so your current wording is misleading.
"When an Integer-type value is needed" seems okay.
stevengj
reviewed
Sep 21, 2018
base/floatfuncs.jl
Outdated
| @@ -19,11 +19,13 @@ signbit(x::Float16) = signbit(bitcast(Int16, x)) | |||
| """ | |||
| maxintfloat(T=Float64) | |||
|
|
|||
| The largest consecutive integer that is exactly represented in the given floating-point type `T` | |||
| (which defaults to `Float64`). | |||
| The largest consecutive integer-valued floating point number that is exactly represented in | |||
There was a problem hiding this comment.
"floating-point number" should be hyphenated (compound adjective)
stevengj
approved these changes
Sep 22, 2018
KristofferC
added
domain:docs
KristofferC
pushed a commit
that referenced
this pull request
Sep 30, 2018
KristofferC
pushed a commit
that referenced
this pull request
Feb 11, 2019
KristofferC
pushed a commit
that referenced
this pull request
Feb 20, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #29297, see discussion there.