Skip to content

Commit 1f11691

Browse files
antonwolfyclaude
andcommitted
Improve Returns section formatting in lu function
Replace bold asterisk formatting with plain descriptive text in Returns section: - "**(If permute_l is False)**" → "When permute_l is False, the function returns:" - "**(If permute_l is True)**" → "When permute_l is True, the function returns:" Also add missing period to parameter description in lu_solve. This follows NumPy/SciPy documentation conventions for clearer, more readable docstrings. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 4301861 commit 1f11691

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

dpnp/scipy/linalg/_decomp_lu.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ def lu(
9595
9696
Returns
9797
-------
98-
**(If ``permute_l`` is ``False``)**
98+
When ``permute_l`` is ``False``, the function returns:
9999
100100
p : (..., M, M) dpnp.ndarray or (..., M) dpnp.ndarray
101101
If `p_indices` is ``False`` (default), the permutation matrix.
@@ -110,7 +110,7 @@ def lu(
110110
u : (..., K, N) dpnp.ndarray
111111
Upper triangular or trapezoidal matrix.
112112
113-
**(If ``permute_l`` is ``True``)**
113+
When ``permute_l`` is ``True``, the function returns:
114114
115115
pl : (..., M, K) dpnp.ndarray
116116
Permuted ``L`` matrix: ``pl = P @ L``.
@@ -273,7 +273,7 @@ def lu_solve(lu_and_piv, b, trans=0, overwrite_b=False, check_finite=True):
273273
lu, piv : {tuple of dpnp.ndarrays or usm_ndarrays}
274274
LU factorization of matrix `a` (..., M, M) together with pivot indices.
275275
b : {(M,), (..., M, K)} {dpnp.ndarray, usm_ndarray}
276-
Right-hand side
276+
Right-hand side.
277277
trans : {0, 1, 2} , optional
278278
Type of system to solve:
279279

0 commit comments

Comments
 (0)