improve docstrings

uber · Mar 23, 2022 · aae2993 · aae2993
1 parent 12eb822
commit aae2993
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/petastorm/pytorch.py b/petastorm/pytorch.py
@@ -103,7 +103,9 @@ def decimal_friendly_collate(batch):
 
 
 class BackgroundIterator(threading.Thread):
-    """Prefetch iterator results."""
+    """Prefetch iterator results. A thread iterates the original iterator and
+    populates a queue. Iterating over this background iterator just consumes the underlying
+    queue until no other result is available."""
     def __init__(self, iterator, prefetch=1000):
         threading.Thread.__init__(self)
         self.queue = Queue(prefetch)