Add brief comments explaining the qr situation

JuliaLang · May 29, 2018 · fd7a2ad · fd7a2ad
1 parent 2447d85
commit fd7a2ad
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/src/Compat.jl b/src/Compat.jl
@@ -1818,6 +1818,8 @@ if !isdefined(Base, :selectdim) # 0.7.0-DEV.3976
 end
 
 if VERSION < v"0.7.0-DEV.2337"
+    # qr doesn't take the full keyword anymore since 0.7.0-DEV.5211; we still support it
+    # here to avoid unneccesary breakage
     if VERSION < v"0.7.0-DEV.843"
         qr(A::Union{Number,AbstractMatrix}, pivot::Union{Val{false},Val{true}}=Val(false); full=false) =
             Base.qr(A, typeof(pivot), thin=!full)

diff --git a/test/runtests.jl b/test/runtests.jl
@@ -1675,6 +1675,9 @@ end
 # 0.7.0-DEV.843 / 0.7.0-DEV.2337
 let A = [1 2; 1 2; 1 2]
     if VERSION < v"0.7.0-DEV.5211"
+        # the full keyword was only temporarily available in Base, so these  methods don't
+        # work on 0.7 anymore, but we test them for the time being to avoid accidentally
+        # anyone's breaking code
         f = Compat.qr(A, Val(false), full=false)
         @test f == Compat.qr(A, Val(false))
         @test length(f) == 2