Mercurial > p > roundup > code
diff doc/design.txt @ 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 | ac1803a09920 |
| children |
line wrap: on
line diff
--- a/doc/design.txt Thu Mar 03 09:52:03 2005 +0000 +++ b/doc/design.txt Thu Mar 03 22:12:36 2005 +0000 @@ -397,10 +397,10 @@ 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 @@ 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}) """
