DOC: order of indices in tril_indices and triu_indices

numpy · May 8, 2024 · 816de7a · 816de7a
1 parent dcd896f
commit 816de7a
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/numpy/lib/_twodim_base_impl.py b/numpy/lib/_twodim_base_impl.py
@@ -909,7 +909,8 @@ def tril_indices(n, k=0, m=None):
     -------
     inds : tuple of arrays
         The indices for the triangle. The returned tuple contains two arrays,
-        each with the indices along one dimension of the array.
+        each with the indices along one dimension of the array. Indices are
+        ordered based on rows and then columns.
 
     See also
     --------
@@ -1059,8 +1060,9 @@ def triu_indices(n, k=0, m=None):
     -------
     inds : tuple, shape(2) of ndarrays, shape(`n`)
         The indices for the triangle. The returned tuple contains two arrays,
-        each with the indices along one dimension of the array.  Can be used
-        to slice a ndarray of shape(`n`, `n`).
+        each with the indices along one dimension of the array. Indices are
+        ordered based on rows and then columns. Can be used to slice a
+        ndarray of shape(`n`, `n`).
 
     See also
     --------