[Zope3-checkins] CVS: Zope3/src/zope/app/interfaces/index - __init__.py:1.4 field.py:1.6 text.py:1.6

[Stephan Richter]

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

Modified Files:
	__init__.py field.py text.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/index/__init__.py 1.3 => 1.4 ===
--- Zope3/src/zope/app/interfaces/index/__init__.py:1.3	Tue Aug  5 04:33:34 2003
+++ Zope3/src/zope/app/interfaces/index/__init__.py	Fri Feb 20 15:33:37 2004
@@ -1,6 +1,20 @@
+##############################################################################
 #
-# This file is necessary to make this directory a package.
+# 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.
+#
+##############################################################################
+"""Index Interfaces
 
+$Id$
+"""
 from zope.interface import Interface
 
 class IInterfaceIndexer(Interface):


=== Zope3/src/zope/app/interfaces/index/field.py 1.5 => 1.6 ===
--- Zope3/src/zope/app/interfaces/index/field.py:1.5	Mon Jul 14 05:56:04 2003
+++ Zope3/src/zope/app/interfaces/index/field.py	Fri Feb 20 15:33:37 2004
@@ -15,7 +15,6 @@
 
 $Id$
 """
-
 from zope.interface import Interface
 from zope.schema import BytesLine
 from zope.app.component.interfacefield import InterfaceField


=== Zope3/src/zope/app/interfaces/index/text.py 1.5 => 1.6 ===
--- Zope3/src/zope/app/interfaces/index/text.py:1.5	Tue Aug  5 04:33:34 2003
+++ Zope3/src/zope/app/interfaces/index/text.py	Fri Feb 20 15:33:37 2004
@@ -15,7 +15,6 @@
 
 $Id$
 """
-
 from zope.interface import Interface
 from zope.schema import BytesLine
 from zope.app.component.interfacefield import InterfaceField
@@ -37,8 +36,8 @@
         """
 
 class IUITextCatalogIndex(IStatistics):
+    """Interface for creating a TextIndex inside a catalog"""
 
-    """Interface for creating a TextIndex from with a catalog"""
     interface = InterfaceField(
                 title=u"Interface", 
                 description=u"Objects will be adapted to this interface",
@@ -51,7 +50,6 @@
                  default="getSearchableText")
 
 class IUITextIndex(IUITextCatalogIndex):
-
     """Interface for creating a TextIndex from the ZMI."""
 
     def subscribe():
@@ -64,7 +62,6 @@
         """Return whether we are currently subscribed."""
 
 class IQueryView(Interface):
-
     """Interface providing a query method that can be invoked from ZPT.
 
     XXX How to express that this is a browser interface?"""