r47055 - Merge predicate-8242: Document PredicateResult

Author: glyph
Date: Wed Mar 23 01:40:26 2016
New Revision: 47055

Added:
   trunk/twisted/topfiles/8242.misc
Modified:
   trunk/twisted/logger/_filter.py

Log:
Merge predicate-8242: Document PredicateResult

Author: glyph

Reviewer: adiroiban

Fixes: #8242

Add docstrings for the values of twisted.logger.PredicateResult.

Modified: trunk/twisted/logger/_filter.py
==============================================================================
--- trunk/twisted/logger/_filter.py	(original)
+++ trunk/twisted/logger/_filter.py	Wed Mar 23 01:40:26 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()