[Zope3-checkins] CVS: Zope3/src/zope/app/interfaces/catalog - catalog.py:1.3

[Stephan Richter]

Update of /cvs-repository/Zope3/src/zope/app/interfaces/catalog
In directory cvs.zope.org:/tmp/cvs-serv31335/src/zope/app/interfaces/catalog

Modified Files:
	catalog.py 
Log Message:
Improved doc strings.

Some of the doc strings I encoountered were in horrible shape! Remember,
the API doc tool can only display the info you provide it via the interfaces.
Bad doc strings == bad API documentation!!!


=== Zope3/src/zope/app/interfaces/catalog/catalog.py 1.2 => 1.3 ===
--- Zope3/src/zope/app/interfaces/catalog/catalog.py:1.2	Sat Jul 12 23:36:00 2003
+++ Zope3/src/zope/app/interfaces/catalog/catalog.py	Fri Feb 20 15:33:36 2004
@@ -1,26 +1,57 @@
+##############################################################################
+#
+# Copyright (c) 2004 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.0 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Catalog Interfaces
+
+$Id$
+"""
 from zope.interface import Interface
 
 class ICatalogView(Interface):
-    "Provides read-only access to Catalog"
+    """Provides information about a catalog."""
+
+    def getSubscribed():
+        """Return 'True', if the catalog is subscribed to events, otherwise
+        'False'."""
 
-    def getSubscribed(): "get current subscription status"
 
 class ICatalogQuery(Interface):
     "Provides Catalog Queries"
+
     def searchResults(**kw):
 	"search on the given indexes"
 
+
 class ICatalogEdit(Interface):
-    "Provides read-write Catalog info"
+    """Allows one to manipulate the Catalog information."""
+
     def clearIndexes(): 
-        "nuke the indexes"
+        """Remove all index data."""
+
     def updateIndexes(): 
-        "reindex all objects"
+        """Reindex all objects."""
+
     def subscribeEvents(update=True): 
-	"start receiving events, if update, reindex all existing events"
+        """Start listening for events.
+
+        Starts listening to events for possible index updating. If 'update' is
+	'True', always reindex all objects.
+        """
+
     def unsubscribeEvents(): 
-	"stop receiving events"
+        """Stop listening to events."""
+
 
 class ICatalog(ICatalogView, ICatalogQuery, ICatalogEdit): 
-    "a content-space catalog"
-    pass
+    """Marker to describe a catalog in content space."""
+