Add note to unsafe_trunc docstring
#54297
Open
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
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.
cf. #54264
The behavior of
unsafe_truncfor out-of-range values appears to be equivalent to “unspecified behavior” (not "undefined behavior"), using the C++ Standard terminology.The trouble with that analogy is that it implicitly reminds me that this works deterministically from a local perspective.
Julia is far more dynamic than languages such as C++, which negates the expectation.
The
NaNexample is also misleading as it implies that it is locally deterministic.However, "worse" examples such as
unsafe_trunc(UInt8, -2.2)should not be there because the doctest fails.I am not a good writer, so I will leave the editing to other reviewers.