Documentation update for LinearAlgebra functions

[aravindh-krishnamoorthy]

Documentation update for LinearAlgebra functions, see #52725

• Pivoting strategies

  • NoPivot
  • RowNonZero
  • ColumnNorm
  • RowMaximum

• Matrix multiplication functions

  • copy_transpose!
  • copyto!

Note: copyto! is not mentioned in the original issue. However, it is felt that copy_transpose! without the complementing copyto! will be confusing for a reader.

• Exceptions
  • LAPACKException
  • RankDeficientException

Reviews

• Self-review of content and language by the author.
• Move PR out of draft state and trigger external reviewers.

Tests

• Test make docs.
• Check generated en HTML files.

[stevengj]

Note that you'll also need to change

julia/stdlib/LinearAlgebra/test/runtests.jl

Lines 8 to 12 in ab9573f

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

to

@testset "Docstrings" begin
    @test isempty(Docs.undocumented_names(LinearAlgebra))
end

[dkarrasch]

Very nice work! I have a few suggestions for consideration. Otherwise looks good to me.

[stevengj]

I suggested a few more clarifications to the pivoting docs, above, which would be good to incorporate before merging.

[vtjnash]

Is this something we can merge before the branch tomorrow, or will it miss the v1.11 window?

[dkarrasch]

We should be able to merge it, or just in case backport.