Try to improve some docstring

JuliaSmoothOptimizers · Oct 30, 2024 · 9fbeffe · 9fbeffe
1 parent 83db3f3
commit 9fbeffe
Showing 1 changed file with 5 additions and 5 deletions.
diff --git 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