Changeset 12951 for main/waeup.kofa/trunk/src/waeup/kofa/catalog.py

Timestamp:

15 May 2015, 08:56:17 (9 years ago)

Author:

Henrik Bettermann

Message:

Simplify headlines in doctests. Remove some API documentation.

File:

• main/waeup.kofa/trunk/src/waeup/kofa/catalog.py (modified) (1 diff)

main/waeup.kofa/trunk/src/waeup/kofa/catalog.py

@@ -32 +32 @@
 @implementer(IQuery)
 class KofaQuery(Query):
-    """A hurry.query-like query that supports also ``apply``.
+    """A `hurry.query.query.Query` compatible query that also supports
+    retrival of plain ``Bree`` result sets as used inside a catalog.
+
+    Like `hurry.query.query.Query` objects, `KofaQuery` is some kind
+    of a meta query or 'compound query' that can give the cataloged
+    objects (or their int ids) matching one or more 'subqueries'.
+
+    This way you can search for objects (or their int ids) that match
+    several criteria at the same time. See ``examples`` section below.
+
+    A singleton instance of this class is also available as global
+    utility.
+
+    A hurry.query-like query that supports also ``apply``.
     """
     def apply(self, query):
-        """Get a catalog's BTree set of intids conforming to a query.
+        """Get the list of int ids (a `BTree` result set) for objects
+        determined by ``query``.
+
+        The list of int ids is less expensive to compute than the
+        complete search results and sufficient, for instance, when you
+        only need the number of objects that match a query and not the
+        objects themselves.
         """
         return query.apply()