chore: update comment

danjac · Sep 11, 2024 · 2d48de5 · 2d48de5
1 parent 8bb25fa
commit 2d48de5
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/radiofeed/paginator.py b/radiofeed/paginator.py
@@ -19,5 +19,8 @@ def paginate(
 
 
 def paginate_lazy(*args, **kwargs) -> SimpleLazyObject:
-    """Returns lazily-evaluated pagination object"""
+    """Returns lazily-evaluated pagination object.
+    Use instead of `paginate()` in cases where the pagination is in a cached template snippet,
+    so the database queries are not evaluated until the page obj is referenced.
+    """
     return SimpleLazyObject(lambda: paginate(*args, **kwargs))