...and some doc strings...

zopefoundation · Aug 17, 1999 · ae7ff55 · ae7ff55
1 parent 1e928da
commit ae7ff55
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/CatalogAwareness.py b/CatalogAwareness.py
@@ -89,6 +89,14 @@
 from Globals import HTMLFile
 
 class CatalogAware:
+    """ This is a Mix-In class to make objects automaticly catalog and
+    uncatalog themselves in Zope, and to provide some other basic
+    attributes that are useful to catalog.  Note that if your class or
+    ZClass subclasses CatalogAware, it will only catalog itself when
+    it is added or copied in Zope.  If you make changes to your own
+    object, you are responsible for calling your object's index_object
+    method. """
+
     meta_type='CatalogAware'
     default_catalog='Catalog'