r47042 - document PredicateResult

Author: glyph
Date: Mon Mar 21 16:46:04 2016
New Revision: 47042

Modified:
   branches/predicate-8242/twisted/logger/_filter.py

Log:
document PredicateResult

Modified: branches/predicate-8242/twisted/logger/_filter.py
==============================================================================
--- branches/predicate-8242/twisted/logger/_filter.py	(original)
+++ branches/predicate-8242/twisted/logger/_filter.py	Mon Mar 21 16:46:04 2016
@@ -19,10 +19,25 @@
 class PredicateResult(Names):
     """
     Predicate results.
-    """
-    yes = NamedConstant()    # Log this
-    no = NamedConstant()     # Don't log this
-    maybe = NamedConstant()  # No opinion
+
+    @see: L{LogLevelFilterPredicate}
+
+    @cvar yes: Log the specified event.  When this value is used,
+        L{LogLevelFilterPredicate} will always log the message, without
+        evaluating other predicates.
+
+    @cvar no: Do not log the specified event.  When this value is used,
+        L{LogLevelFilterPredicate} will I{not} log the message, without
+        evaluating other predicates.
+
+    @cvar maybe: Do not have an opinion on the event.  When this value is used,
+        L{LogLevelFilterPredicate} will consider subsequent predicate results;
+        if returned by the last predicate being considered, then the event will
+        be logged.
+    """
+    yes = NamedConstant()
+    no = NamedConstant()
+    maybe = NamedConstant()