[Zope-Checkins] CVS: Zope/lib/python/Products/ZCatalog - IZCatalog.py:1.4

[Shane Hathaway]

Update of /cvs-repository/Zope/lib/python/Products/ZCatalog
In directory cvs.zope.org:/tmp/cvs-serv6093

Modified Files:
	IZCatalog.py 
Log Message:
Documented two features of the catalog:

- You can pass the list of indexes to update to catalog_object().

- uids can be relative rather than absolute.


=== Zope/lib/python/Products/ZCatalog/IZCatalog.py 1.3 => 1.4 ===
--- Zope/lib/python/Products/ZCatalog/IZCatalog.py:1.3	Wed Aug 14 18:25:15 2002
+++ Zope/lib/python/Products/ZCatalog/IZCatalog.py	Thu Sep  5 17:22:39 2002
@@ -66,16 +66,20 @@
 
     """
 
-    def catalog_object(obj, uid):
+    def catalog_object(obj, uid, idxs=[]):
         """Catalogs the object 'obj' with the unique identifier 'uid'.
 
-        The uid must be a physical path!
+        The uid must be a physical path, either absolute or relative to
+        the catalog.
+
+        If provided, idxs specifies the names of indexes to update.
         """
 
     def uncatalog_object(uid):
         """Uncatalogs the object with the unique identifier 'uid'.
 
-        The uid must be a physical path!
+        The uid must be a physical path, either absolute or relative to
+        the catalog.
         """
 
     def uniqueValuesFor(name):