fixed documentation of filter()...

...in the case of multiple values in a String search [SF#1373396]

Author: Richard Jones

CHANGES.txt

@@ -23,6 +23,8 @@ Fixed:
   are highlighted as required fields (sf bug 1392364)
 - french translation updated by Patrick Decat (sf patch 1397059)
 - HTTP authorization takes precedence over session cookie (sf bug 1396134)
+- fixed documentation of filter() in the case of multiple values in a
+  String search (sf bug 1373396)
 
 
 2005-10-07 0.9.0b1

roundup/backends/back_anydbm.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 #
-#$Id: back_anydbm.py,v 1.190 2005-10-07 05:35:03 richard Exp $
+#$Id: back_anydbm.py,v 1.191 2006-01-13 00:05:46 richard Exp $
 '''This module defines a backend that saves the hyperdatabase in a
 database chosen by anydbm. It is guaranteed to always be available in python
 versions >2.1.1 (the dumbdbm fallback in 2.1.1 and earlier has several
@@ -1574,9 +1574,11 @@ def filter(self, search_matches, filterspec, sort=(None,None),
 
         "search_matches" is {nodeid: marker} or None
 
-        The filter must match all properties specificed - but if the
-        property value to match is a list, any one of the values in the
-        list may match for that property to match.
+        The filter must match all properties specificed. If the property
+        value to match is a list:
+        
+        1. String properties must match all elements in the list, and
+        2. Other properties must match any of the elements in the list.
         """
         if __debug__:
             start_t = time.time()

roundup/backends/back_mysql.py

@@ -1,4 +1,4 @@
-#$Id: back_mysql.py,v 1.60 2005-10-24 03:37:11 richard Exp $
+#$Id: back_mysql.py,v 1.61 2006-01-13 00:05:46 richard Exp $
 #
 # Copyright (c) 2003 Martynas Sklyzmantas, Andrey Lebedev <[email protected]>
 #
@@ -508,9 +508,11 @@ def filter(self, search_matches, filterspec, sort=(None,None),
 
         "search_matches" is {nodeid: marker} or None
 
-        The filter must match all properties specificed - but if the
-        property value to match is a list, any one of the values in the
-        list may match for that property to match.
+        The filter must match all properties specificed. If the property
+        value to match is a list:
+
+        1. String properties must match all elements in the list, and
+        2. Other properties must match any of the elements in the list.
         '''
         # we can't match anything if search_matches is empty
         if search_matches == {}:

roundup/backends/rdbms_common.py

@@ -1,4 +1,4 @@
-# $Id: rdbms_common.py,v 1.159 2005-10-07 05:35:04 richard Exp $
+# $Id: rdbms_common.py,v 1.160 2006-01-13 00:05:46 richard Exp $
 ''' Relational database (SQL) backend common code.
 
 Basics:
@@ -2050,9 +2050,11 @@ def filter(self, search_matches, filterspec, sort=(None,None),
 
         "search_matches" is {nodeid: marker} or None
 
-        The filter must match all properties specificed - but if the
-        property value to match is a list, any one of the values in the
-        list may match for that property to match.
+        The filter must match all properties specificed. If the property
+        value to match is a list:
+
+        1. String properties must match all elements in the list, and
+        2. Other properties must match any of the elements in the list.
         '''
         # we can't match anything if search_matches is empty
         if search_matches == {}:

roundup/hyperdb.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 #
-# $Id: hyperdb.py,v 1.111 2005-07-18 02:35:18 richard Exp $
+# $Id: hyperdb.py,v 1.112 2006-01-13 00:05:46 richard Exp $
 
 """Hyperdatabase implementation, especially field types.
 """
@@ -648,9 +648,11 @@ def filter(self, search_matches, filterspec, sort=(None,None),
 
         "search_matches" is {nodeid: marker}
 
-        The filter must match all properties specificed - but if the
-        property value to match is a list, any one of the values in the
-        list may match for that property to match.
+        The filter must match all properties specificed. If the property
+        value to match is a list:
+
+        1. String properties must match all elements in the list, and
+        2. Other properties must match any of the elements in the list.
         """
         raise NotImplementedError