Documentation update for LinearAlgebra functions

stdlib/LinearAlgebra/src/LinearAlgebra.jl

@@ -190,6 +190,8 @@ abstract type Algorithm end
 struct DivideAndConquer <: Algorithm end
 struct QRIteration <: Algorithm end
 
+# TODO: Insert docstrings for pivoting strategies here.
+
 abstract type PivotingStrategy end
 struct NoPivot <: PivotingStrategy end
 struct RowNonZero <: PivotingStrategy end

stdlib/LinearAlgebra/src/exceptions.jl

@@ -6,6 +6,8 @@ export LAPACKException,
        RankDeficientException,
        ZeroPivotException
 
+# TODO: Insert docstring for LAPACKException here.
+
 struct LAPACKException <: Exception
     info::BlasInt
 end
@@ -41,6 +43,8 @@ function Base.showerror(io::IO, ex::PosDefException)
     print(io, "; Factorization failed.")
 end
 
+# TODO: Insert docstring for RankDeficientException here.
+
 struct RankDeficientException <: Exception
     info::BlasInt
 end

stdlib/LinearAlgebra/src/matmul.jl

@@ -692,6 +692,8 @@ function copyto!(B::AbstractVecOrMat, ir_dest::AbstractUnitRange{Int}, jr_dest::
     B
 end
 
+# TODO: Insert docstring for copy_transpose! here.
+
 function copy_transpose!(B::AbstractMatrix, ir_dest::AbstractUnitRange{Int}, jr_dest::AbstractUnitRange{Int}, tM::AbstractChar, M::AbstractVecOrMat, ir_src::AbstractUnitRange{Int}, jr_src::AbstractUnitRange{Int})
     if tM == 'N'
         LinearAlgebra.copy_transpose!(B, ir_dest, jr_dest, M, ir_src, jr_src)

stdlib/LinearAlgebra/test/runtests.jl

@@ -7,6 +7,4 @@ end
 
 @testset "Docstrings" begin
     undoc = Docs.undocumented_names(LinearAlgebra)
-    @test_broken isempty(undoc)
-    @test undoc == [:ColumnNorm, :LAPACKException, :NoPivot, :RankDeficientException, :RowMaximum, :RowNonZero, :copy_transpose!]
 end