space: Document the logic in iter_cell_list_contents

jingxuanlim · Mar 27, 2022 · a99fa4d · a99fa4d
1 parent 77e8dfa
commit a99fa4d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/mesa/space.py b/mesa/space.py
@@ -381,6 +381,9 @@ def iter_cell_list_contents(
         Returns:
             An iterator of the contents of the cells identified in cell_list
         """
+        # Note: filter(None, iterator) filters away an element of iterator that
+        # is falsy. Hence, iter_cell_list_contents returns only non-empty
+        # contents.
         return filter(None, (self.grid[x][y] for x, y in cell_list))
 
     @accept_tuple_argument