diff roundup/backends/back_metakit.py @ 3237:ed97e2a85576 maint-0.8

clearer docs for find(); couple of other post-release fixes
author Richard Jones <richard@users.sourceforge.net>
date Thu, 03 Mar 2005 22:12:36 +0000
parents e1da7b5b04ab
children 985ba73ca6ad
line wrap: on
line diff
--- a/roundup/backends/back_metakit.py	Thu Mar 03 09:52:03 2005 +0000
+++ b/roundup/backends/back_metakit.py	Thu Mar 03 22:12:36 2005 +0000
@@ -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 @@
             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 Issue Tracker: http://roundup-tracker.org/