From ec767d9c1c6fd67113b851f5435c6aef4b634a1b Mon Sep 17 00:00:00 2001 From: Jaakko Ruohio Date: Mon, 7 Jul 2025 22:06:54 +0300 Subject: [PATCH] Update docs for polar() keyword argument, it is alg (not algorithm) --- src/polar.jl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/polar.jl b/src/polar.jl index 5c10530..65a0c1d 100644 --- a/src/polar.jl +++ b/src/polar.jl @@ -4,7 +4,7 @@ export polar, PolarDecomposition """ - polar(A; algorithm::Symbol, maxiter, tol, verbose) + polar(A; alg::Symbol, maxiter, tol, verbose) Compute the polar decomposition of the matrix `A`. @@ -12,7 +12,7 @@ Returns a [`PolarDecomposition`](@ref). Arguments: -`algorithm` (default: `:newton`) may be one of: +`alg` (default: `:newton`) may be one of: - ``:newton``: scaled Newton's method - ``:qdwh``: the QR-based Dynamically weighted Halley (QDWH) method - ``:halley``: Halley's method