Skip to content

Commit ea12df3

Browse files
committed
fixup: docstring changes
1 parent 0fa3632 commit ea12df3

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

python/lsst/analysis/tools/actions/plot/plotUtils.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -358,17 +358,18 @@ def sortAllArrays(arrsToSort, sortArrayIndex=0):
358358
359359
Parameters
360360
----------
361-
arrsToSort : `list` [`np.array`]
362-
A list of arrays to be simultaneously sorted based on the array in
363-
the list position given by ``sortArrayIndex`` (defaults to be the
364-
first array in the list).
361+
arrsToSort : `list` [`np.array`] | `list` [`pd.Series`]
362+
A list of arrays or Series to be simultaneously sorted based on the
363+
array in the list position given by ``sortArrayIndex`` (defaults to be
364+
the first array in the list).
365365
sortArrayIndex : `int`, optional
366366
Zero-based index indicating the array on which to base the sorting.
367367
368368
Returns
369369
-------
370-
arrsToSort : `list` [`np.array`]
371-
The list of arrays sorted on array in list index ``sortArrayIndex``.
370+
arrsToSort : `list` [`np.array`] | `list` [`pd.Series`]
371+
The list of arrays or Series (same type as the input) sorted on array
372+
in list index ``sortArrayIndex``.
372373
"""
373374
ids = extremaSort(arrsToSort[sortArrayIndex])
374375
for i, arr in enumerate(arrsToSort):

0 commit comments

Comments
 (0)