From 9fbeffedcb681867913dc74a91920eb61d7b3c84 Mon Sep 17 00:00:00 2001 From: Alexis Montoison Date: Wed, 30 Oct 2024 15:24:02 -0500 Subject: [PATCH] Try to improve some docstring --- src/usymqr.jl | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/usymqr.jl b/src/usymqr.jl index 812f30c81..e385ef43f 100644 --- a/src/usymqr.jl +++ b/src/usymqr.jl @@ -50,13 +50,13 @@ USYMQR finds the minimum-norm solution if problems are inconsistent. #### Input arguments -* `A`: a linear operator that models a matrix of dimension m × n; -* `b`: a vector of length m; -* `c`: a vector of length n. +* `A`: a linear operator that models a matrix of dimension `m × n`; +* `b`: a vector of length `m`; +* `c`: a vector of length `n`. #### Optional argument -* `x0`: a vector of length n that represents an initial guess of the solution x. +* `x0`: a vector of length `n` that represents an initial guess of the solution `x`. #### Keyword arguments @@ -71,7 +71,7 @@ USYMQR finds the minimum-norm solution if problems are inconsistent. #### Output arguments -* `x`: a dense vector of length n; +* `x`: a dense vector of length `n`; * `stats`: statistics collected on the run in a [`SimpleStats`](@ref) structure. #### References