Improve the docstrings of block-Krylov processes

JuliaSmoothOptimizers · Oct 17, 2024 · c61359b · c61359b
1 parent 5c001fd
commit c61359b
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/src/block_krylov_processes.jl b/src/block_krylov_processes.jl
@@ -9,7 +9,7 @@
 
 #### Keyword arguments
 
-* `algo`: the algorithm to perform reduced QR factorizations ("gs", "mgs", "givens" or "householder").
+* `algo`: the algorithm to perform reduced QR factorizations (`"gs"`, `"mgs"`, `"givens"` or `"householder"`).
 
 #### Output arguments
 
@@ -237,7 +237,7 @@ end
 
 #### Keyword arguments
 
-* `algo`: the algorithm to perform reduced QR factorizations ("gs", "mgs", "givens" or "householder").
+* `algo`: the algorithm to perform reduced QR factorizations (`"gs"`, `"mgs"`, `"givens"` or `"householder"`).
 * `reorthogonalization`: reorthogonalize the new matrices of the block Krylov basis against all previous matrices.
 
 #### Output arguments
@@ -314,7 +314,7 @@ end
 
 #### Keyword argument
 
-* `algo`: the algorithm to perform reduced QR factorizations ("gs", "mgs", "givens" or "householder").
+* `algo`: the algorithm to perform reduced QR factorizations (`"gs"`, `"mgs"`, `"givens"` or `"householder"`).
 
 #### Output arguments
 
@@ -428,7 +428,7 @@ end
 
 #### Keyword argument
 
-* `algo`: the algorithm to perform reduced QR factorizations ("gs", "mgs", "givens" or "householder").
+* `algo`: the algorithm to perform reduced QR factorizations (`"gs"`, `"mgs"`, `"givens"` or `"householder"`).
 
 #### Output arguments
 
@@ -568,7 +568,7 @@ end
 
 #### Keyword arguments
 
-* `algo`: the algorithm to perform reduced QR factorizations ("gs", "mgs", "givens" or "householder").
+* `algo`: the algorithm to perform reduced QR factorizations (`"gs"`, `"mgs"`, `"givens"` or `"householder"`).
 * `reorthogonalization`: reorthogonalize the new matrices of the block Krylov basis against all previous matrices.
 
 #### Output arguments