From 2d48de57080dcd4db1dd8326edeb41184fb8ef51 Mon Sep 17 00:00:00 2001 From: Dan Jacob Date: Wed, 11 Sep 2024 11:32:32 +0300 Subject: [PATCH] chore: update comment --- radiofeed/paginator.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/radiofeed/paginator.py b/radiofeed/paginator.py index 24ec11fa5..6b4a98cee 100644 --- 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))