common/_itertools: Add documentation to all_same

10 months ago · 1de9c82d4a
parent f91f15e81f
commit 1de9c82d4a
1 changed files with 3 additions and 0 deletions
--- a/server/entertainment_decider/common/_itertools.py
+++ b/server/entertainment_decider/common/_itertools.py
@ -17,6 +17,9 @@ T = TypeVar("T")


 def all_same(iterable: Iterable) -> bool:
+    """
+    Returns True if all items of Iterable are equal, False otherwise.
+    """
    it = iter(iterable)
    first = next(it)
    return all(first == elem for elem in it)