clearer docs for find(); couple of other post-release fixes

Author: Richard Jones

doc/announcement.txt

@@ -5,10 +5,12 @@ from Ka-Ping Yee in the Software Carpentry "Track" design competition.
 This 0.8.2 release adds one feature and fixes some bugs:
 
 Feature:
+
 - roundup-server automatically redirects from trackers list
   to the tracker page if there is only one tracker
 
 Fixed:
+
 - added content to ZRoundup refresh.txt file (sf bug 1147622)
 - fix invalid reference to csv.colon_separated
 - correct URL to What's New in setup.py meta-data

doc/design.txt

@@ -397,10 +397,10 @@ Here is the interface provided by the hyperdatabase::
             properties.
             """
 
-        def restore(self, nodeid):
-        '''Restore a retired node.
+        def restore(self, itemid):
+        '''Restore a retired item.
 
-        Make node available for all operations like it was before
+        Make item available for all operations like it was before
         retirement.
         '''
 
@@ -452,20 +452,21 @@ Here is the interface provided by the hyperdatabase::
             id is returned; otherwise a KeyError is raised.
             """
 
-        def find(self, propname, itemid):
+        def find(self, **propspec):
             """Get the ids of items in this class which link to the
             given items.
 
-            'propspec' consists of keyword args propname={itemid:1,}
-            'propname' must be the name of a property in this class, or
-            a KeyError is raised.  That property must be a Link or
-            Multilink property, or a TypeError is raised.
+            'propspec' consists of keyword args propname=itemid or
+                       propname={<itemid 1>:1, <itemid 2>: 1, ...}
+            'propname' must be the name of a property in this class,
+                       or a KeyError is raised.  That property must
+                       be a Link or Multilink property, or a TypeError
+                       is raised.
 
             Any item in this class whose 'propname' property links to
-            any of the itemids will be returned. Used by the full text
-            indexing, which knows that "foo" occurs in msg1, msg3 and
-            file7, so we have hits on these issues:
+            any of the itemids will be returned. Examples::
 
+                db.issue.find(messages='1')
                 db.issue.find(messages={'1':1,'3':1}, files={'7':1})
             """
 

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.179.2.6 2005-02-14 05:40:54 richard Exp $
+#$Id: back_anydbm.py,v 1.179.2.7 2005-03-03 22:12:35 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
@@ -1431,16 +1431,15 @@ def find(self, **propspec):
         '''Get the ids of items in this class which link to the given items.
 
         'propspec' consists of keyword args propname=itemid or
-                   propname={itemid:1, }
+                   propname={<itemid 1>:1, <itemid 2>: 1, ...}
         'propname' must be the name of a property in this class, or a
                    KeyError is raised.  That property must be a Link or
                    Multilink property, or a TypeError is raised.
 
-        Any item in this class whose 'propname' property links to any of the
-        itemids will be returned. Used by the full text indexing, which knows
-        that "foo" occurs in msg1, msg3 and file7, so we have hits on these
-        issues:
+        Any item in this class whose 'propname' property links to any of
+        the itemids will be returned. Examples::
 
+            db.issue.find(messages='1')
             db.issue.find(messages={'1':1,'3':1}, files={'7':1})
         '''
         propspec = propspec.items()

roundup/backends/back_metakit.py

@@ -1,4 +1,4 @@
-# $Id: back_metakit.py,v 1.88.2.3 2005-02-14 02:55:31 richard Exp $
+# $Id: back_metakit.py,v 1.88.2.4 2005-03-03 22:12:35 richard Exp $
 '''Metakit backend for Roundup, originally by Gordon McMillan.
 
 Known Current Bugs:
@@ -1082,20 +1082,18 @@ def destroy(self, id):
             self.db.dirty = 1
 
     def find(self, **propspec):
-        '''Get the ids of nodes in this class which link to the given nodes.
+        '''Get the ids of items in this class which link to the given items.
 
-        'propspec'
-             consists of keyword args propname={nodeid:1,}
-        'propname'
-             must be the name of a property in this class, or a
-             KeyError is raised.  That property must be a Link or
-             Multilink property, or a TypeError is raised.
+        'propspec' consists of keyword args propname=itemid or
+                   propname={<itemid 1>:1, <itemid 2>: 1, ...}
+        'propname' must be the name of a property in this class, or a
+                   KeyError is raised.  That property must be a Link or
+                   Multilink property, or a TypeError is raised.
 
-        Any node in this class whose propname property links to any of the
-        nodeids will be returned. Used by the full text indexing, which knows
-        that "foo" occurs in msg1, msg3 and file7; so we have hits on these
-        issues::
+        Any item in this class whose 'propname' property links to any of
+        the itemids will be returned. Examples::
 
+            db.issue.find(messages='1')
             db.issue.find(messages={'1':1,'3':1}, files={'7':1})
         '''
         propspec = propspec.items()

roundup/backends/rdbms_common.py

@@ -1,4 +1,4 @@
-# $Id: rdbms_common.py,v 1.142.2.6 2005-03-02 14:09:30 a1s Exp $
+# $Id: rdbms_common.py,v 1.142.2.7 2005-03-03 22:12:36 richard Exp $
 ''' Relational database (SQL) backend common code.
 
 Basics:
@@ -1885,19 +1885,18 @@ def lookup(self, keyvalue):
         return str(row[0])
 
     def find(self, **propspec):
-        '''Get the ids of nodes in this class which link to the given nodes.
+        '''Get the ids of items in this class which link to the given items.
 
-        'propspec' consists of keyword args propname=nodeid or
-                   propname={nodeid:1, }
+        'propspec' consists of keyword args propname=itemid or
+                   propname={<itemid 1>:1, <itemid 2>: 1, ...}
         'propname' must be the name of a property in this class, or a
                    KeyError is raised.  That property must be a Link or
                    Multilink property, or a TypeError is raised.
 
-        Any node in this class whose 'propname' property links to any of the
-        nodeids will be returned. Used by the full text indexing, which knows
-        that "foo" occurs in msg1, msg3 and file7, so we have hits on these
-        issues:
+        Any item in this class whose 'propname' property links to any of
+        the itemids will be returned. Examples::
 
+            db.issue.find(messages='1')
             db.issue.find(messages={'1':1,'3':1}, files={'7':1})
         '''
         # shortcut

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.107 2004-11-25 22:51:06 richard Exp $
+# $Id: hyperdb.py,v 1.107.2.1 2005-03-03 22:12:35 richard Exp $
 
 """Hyperdatabase implementation, especially field types.
 """
@@ -494,20 +494,20 @@ def lookup(self, keyvalue):
         raise NotImplementedError
 
     def find(self, **propspec):
-        """Get the ids of nodes in this class which link to the given nodes.
+        '''Get the ids of items in this class which link to the given items.
 
-        'propspec' consists of keyword args propname={nodeid:1,}
+        'propspec' consists of keyword args propname=itemid or
+                   propname={<itemid 1>:1, <itemid 2>:1, ...}
         'propname' must be the name of a property in this class, or a
-        KeyError is raised.  That property must be a Link or Multilink
-        property, or a TypeError is raised.
+                   KeyError is raised.  That property must be a Link or
+                   Multilink property, or a TypeError is raised.
 
-        Any node in this class whose 'propname' property links to any of the
-        nodeids will be returned. Used by the full text indexing, which knows
-        that "foo" occurs in msg1, msg3 and file7, so we have hits on these
-        issues:
+        Any item in this class whose 'propname' property links to any of
+        the itemids will be returned. Examples::
 
+            db.issue.find(messages='1')
             db.issue.find(messages={'1':1,'3':1}, files={'7':1})
-        """
+        '''
         raise NotImplementedError
 
     def filter(self, search_matches, filterspec, sort=(None,None),

setup.py

@@ -16,7 +16,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 #
-# $Id: setup.py,v 1.77.2.6 2005-03-03 04:47:35 richard Exp $
+# $Id: setup.py,v 1.77.2.7 2005-03-03 22:12:35 richard Exp $
 
 from distutils.core import setup, Extension
 from distutils.util import get_platform
@@ -347,7 +347,7 @@ def main():
         'download_url': 'http://sourceforge.net/project/showfiles.php?group_id=31577',
         'packages': packagelist,
         'classifiers': [
-            'Development Status :: 5 - Stable',
+            'Development Status :: 5 - Production/Stable',
             'Environment :: Console',
             'Environment :: Web Environment',
             'Intended Audience :: End Users/Desktop',