DOC: Update diags param descr in spdiags fn.

01halibut · Oct 21, 2021 · d4c4047 · d4c4047
1 parent 597a2ef
commit d4c4047
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/scipy/sparse/construct.py b/scipy/sparse/construct.py
@@ -30,10 +30,11 @@ def spdiags(data, diags, m, n, format=None):
     ----------
     data : array_like
         matrix diagonals stored row-wise
-    diags : diagonals to set
-        - k = 0  the main diagonal
-        - k > 0  the k-th upper diagonal
-        - k < 0  the k-th lower diagonal
+    diags : sequence of int or an int
+        Diagonals to set:
+          - k = 0  the main diagonal
+          - k > 0  the kth upper diagonal
+          - k < 0  the kth lower diagonal
     m, n : int
         shape of the result
     format : str, optional