From 4f549f8655857aef64ed8c92c3339c32f5e942db Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Wed, 6 Jan 2016 23:27:09 -0500 Subject: Docstring. --- src/mailman/utilities/queries.py | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'src/mailman/utilities/queries.py') diff --git a/src/mailman/utilities/queries.py b/src/mailman/utilities/queries.py index 6f4bc6b4d..fa8cb04aa 100644 --- a/src/mailman/utilities/queries.py +++ b/src/mailman/utilities/queries.py @@ -26,6 +26,12 @@ from collections.abc import Sequence class QuerySequence(Sequence): + """A simple wrapper class around database query results. + + Use this to provide a sequence-like API around query results, such as + being able to use len() and slicing, where the results objects don't + natively provide them. + """ def __init__(self, query=None): super().__init__() self._query = query -- cgit v1.2.3-70-g09d2