Skip to content

Commit 0df030d

Browse files
make return for single spiketrain explicit
1 parent b15b77d commit 0df030d

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

elephant/utils.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,8 @@ def is_list_spiketrains(obj: object) -> bool:
463463
Returns
464464
-------
465465
bool
466-
True if obj is an iterable containing only neo.SpikeTrain objects.
466+
True if obj is an iterable containing only neo.SpikeTrain objects. A single `neo.SpikeTrain` object (not inside
467+
an iterable) will return `False`.
467468
468469
"""
469470

0 commit comments

Comments
 (0)