Skip to content

Commit 046358d

Browse files
committed
fixup: docstring changes
1 parent e4a7092 commit 046358d

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
@@ -385,17 +385,18 @@ def sortAllArrays(arrsToSort, sortArrayIndex=0):
385385
386386
Parameters
387387
----------
388-
arrsToSort : `list` [`np.array`]
389-
A list of arrays to be simultaneously sorted based on the array in
390-
the list position given by ``sortArrayIndex`` (defaults to be the
391-
first array in the list).
388+
arrsToSort : `list` [`np.array`] | `list` [`pd.Series`]
389+
A list of arrays or Series to be simultaneously sorted based on the
390+
array in the list position given by ``sortArrayIndex`` (defaults to be
391+
the first array in the list).
392392
sortArrayIndex : `int`, optional
393393
Zero-based index indicating the array on which to base the sorting.
394394
395395
Returns
396396
-------
397-
arrsToSort : `list` [`np.array`]
398-
The list of arrays sorted on array in list index ``sortArrayIndex``.
397+
arrsToSort : `list` [`np.array`] | `list` [`pd.Series`]
398+
The list of arrays or Series (same type as the input) sorted on array
399+
in list index ``sortArrayIndex``.
399400
"""
400401
ids = extremaSort(arrsToSort[sortArrayIndex])
401402
for i, arr in enumerate(arrsToSort):

0 commit comments

Comments
 (0)