Add compat annotation for NaN handling in (l|r)mul! #30361
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
This patch also adds tests to check the documented behavior.
|
I just noticed #29726 has more discussion and it was considered actually a bug fix #29726 (comment) Nevertheless, it's good to have docs and tests. |
stdlib/LinearAlgebra/src/generic.jl
Outdated
| modified (unless the type of `b` defines a non-standard behavior). | ||
|
|
||
| !!! compat "Julia 1.1" | ||
| Prior to Julia 1.1, how `NaN` entries in `A` were treated was |
There was a problem hiding this comment.
Maybe rephrase to something like Prior to Julia 1.1, NaNentries inA were treated inconsistently.
There was a problem hiding this comment.
Thanks, that's much smoother. I changed the docstring. I also mention Inf since that's also changed.
fredrikekre
added
docs
andreasnoack
approved these changes
Dec 12, 2018
KristofferC
pushed a commit
that referenced
this pull request
Dec 12, 2018
(cherry picked from commit 797ddbb)
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.
As discussed in JuliaLang/LinearAlgebra.jl#560, the behavior of
lmul!andrmul!was changed between 1.0 and 1.1. I think issue JuliaLang/LinearAlgebra.jl#560 should be treated as an API documentation bug (and I think it would be nice if similar issues are closed by PRs addressing the issue). This PR adds docstring to elaborate the API of those functions and adds compat annotation for the incompatible change.