[Zope-Checkins] CVS: Zope2 - Vocabulary.py:1.5 ZCatalog.py:1.6

[Amos Latteier]

Update of /cvs-repository/Zope2/lib/python/Products/ZCatalog/help
In directory korak:/tmp/cvs-serv29065/ZCatalog/help

Modified Files:
	Vocabulary.py ZCatalog.py 
Log Message:
Many small structured text fixes, typos fixes, and small wording and formatting corrections. Some of these were pointed out by Tom Deprez.



--- Updated File Vocabulary.py in package Zope2 --
--- Vocabulary.py	2000/07/03 21:55:22	1.4
+++ Vocabulary.py	2001/04/17 23:29:26	1.5
@@ -83,7 +83,7 @@
 # 
 ##############################################################################
 
-def manage_addVocabulary(self, id, title, globbing=None, REQUEST=None):
+def manage_addVocabulary(id, title, globbing=None, REQUEST=None):
     """
 
     Add a Vocabulary object to an ObjectManager.
@@ -105,7 +105,7 @@
 
     __constructor__=manage_addVocabulary
 
-    def query(self, pattern):
+    def query(pattern):
         """
 
         Query Vocabulary for words matching pattern.
@@ -113,14 +113,14 @@
         """
             
 
-    def insert(self, word):
+    def insert(word):
         """
 
         Insert a word in the Vocabulary.
 
         """
         
-    def words(self):
+    def words():
         """
 
         Return list of words.

--- Updated File ZCatalog.py in package Zope2 --
--- ZCatalog.py	2000/07/03 21:55:22	1.5
+++ ZCatalog.py	2001/04/17 23:29:26	1.6
@@ -83,7 +83,7 @@
 # 
 ##############################################################################
 
-def manage_addZCatalog(self, id, title, vocab_id=None):
+def manage_addZCatalog(id, title, vocab_id=None):
     """
 
     Add a ZCatalog object.
@@ -106,7 +106,8 @@
     objects.  ZCatalog's can index either 'Field' values of object,
     'Text' values, or 'KeyWord' values:
 
-    Indexes
+    ZCatalogs have three types of
+    indexes:
 
       Text -- Text indexes index textual content.  The index can be
       used to search for objects containing certain words.
@@ -118,16 +119,14 @@
       can be used to search for objects that match one or more of the
       search terms.
 
-    Meta-data
+    The ZCatalog can maintain a table of extra data about cataloged
+    objects.  This information can be used on search result pages to
+    show information about a search result.
+
+    The meta-data table schema is used to build the schema for
+    ZCatalog Result objects.  The objects have the same attributes
+    as the column of the meta-data table.
 
-      The ZCatalog can maintain a table of extra data about cataloged
-      objects.  This information can be used on search result pages to
-      show information about a search result.
-
-      The meta-data table schema is used to build the schema for
-      ZCatalog Result objects.  The objects have the same attributes
-      as the column of the meta-data table.
-
     ZCatalog does not store references to the objects themselves, but
     rather to a unique identifier that defines how to get to the
     object.  In Zope, this unique identifier is the object's relative
@@ -138,28 +137,28 @@
 
     __constructor__=manage_addZCatalog
 
-    def catalog_object(self, obj, uid):
+    def catalog_object(obj, uid):
         """
 
         Catalogs the object 'obj' with the unique identifier 'uid'.
 
         """
 
-    def uncatalog_object(self, uid):
+    def uncatalog_object(uid):
         """
 
         Uncatalogs the object with the unique identifier 'uid'.
 
         """
 
-    def uniqueValuesFor(self, name):
+    def uniqueValuesFor(name):
         """
 
         returns the unique values for a given FieldIndex named 'name'.
 
         """
 
-    def getpath(self, rid):
+    def getpath(rid):
         """
         
         Return the path to a cataloged object given a
@@ -168,14 +167,14 @@
         """
 
 
-    def getobject(self, rid, REQUEST=None):
+    def getobject(rid, REQUEST=None):
         """
         
         Return a cataloged object given a 'data_record_id_'
         
         """
 
-    def schema(self):
+    def schema():
         """
 
         Returns a sequence of names that correspond to columns in the
@@ -183,21 +182,21 @@
 
         """
 
-    def indexes(self):
+    def indexes():
         """
 
         Returns a sequence of names that correspond to indexes.
 
         """
 
-    def index_objects(self):
+    def index_objects():
         """
 
         Returns a sequence of actual index objects.
 
         """
 
-    def searchResults(self, REQUEST=None, **kw):
+    def searchResults(REQUEST=None, **kw):
         """
         
         Search the catalog.  Search terms can be passed in the REQUEST
@@ -209,7 +208,7 @@
 
         """
     
-    def __call__(self, REQUEST=None, **kw):
+    def __call__(REQUEST=None, **kw):
         """
         Search the catalog, the same way as 'searchResults'.
         """