[Zodb-checkins] SVN: ZODB/trunk/ Merge rev 30976 from 3.4 branch.

[Tim Peters]

Log message for revision 30977:
  Merge rev 30976 from 3.4 branch.
  
  Collector 1829.
  
  Clarified that the ``minKey()`` and ``maxKey()`` methods raise an exception
  if no key exists satsifying the constraints.
  
  Also improved the English in other interface docstrings.
  

Changed:
  U   ZODB/trunk/NEWS.txt
  U   ZODB/trunk/src/BTrees/Interfaces.py

-=-
Modified: ZODB/trunk/NEWS.txt
===================================================================
--- ZODB/trunk/NEWS.txt	2005-07-01 21:32:56 UTC (rev 30976)
+++ ZODB/trunk/NEWS.txt	2005-07-01 21:38:17 UTC (rev 30977)
@@ -59,7 +59,13 @@
   very valuable when you want to spot strange transaction sizes via Zope's
   'Undo' tab".
 
+BTrees interface
+----------------
 
+- (3.5a4S) Collector 1829.  Clarified that the ``minKey()`` and ``maxKey()``
+  methods raise an exception if no key exists satsifying the constraints.
+
+
 What's new in ZODB3 3.4.1a3?
 ============================
 Release date: DD-MMM-2005
@@ -67,6 +73,7 @@
 Following are dates of internal releases (to support ongoing Zope 2
 development) since ZODB 3.4's last public release:
 
+- 3.4.1a3 DD-MMM-2005
 - 3.4.1a2 29-Jun-2005
 - 3.4.1a1 27-Jun-2005
 
@@ -117,7 +124,13 @@
 
 - The implementation of ``undoLog()`` was wrong in several ways; repaired.
 
+BTrees interface
+----------------
 
+- (3.4.1a3) Collector 1829.  Clarified that the ``minKey()`` and ``maxKey()``
+  methods raise an exception if no key exists satsifying the constraints.
+
+
 What's new in ZODB3 3.4?
 ========================
 Release date: 09-Jun-2005

Modified: ZODB/trunk/src/BTrees/Interfaces.py
===================================================================
--- ZODB/trunk/src/BTrees/Interfaces.py	2005-07-01 21:32:56 UTC (rev 30976)
+++ ZODB/trunk/src/BTrees/Interfaces.py	2005-07-01 21:38:17 UTC (rev 30977)
@@ -18,32 +18,31 @@
 class ICollection(Interface):
 
     def clear():
-        """Remove all of the items from the collection"""
+        """Remove all of the items from the collection."""
 
     def __nonzero__():
         """Check if the collection is non-empty.
 
         Return a true value if the collection is non-empty and a
-        false otherwise.
+        false value otherwise.
         """
 
 
 class IReadSequence(Interface):
 
     def __getitem__(index):
-        """Return a value at the given index
+        """Return the value at the given index.
 
         An IndexError is raised if the index cannot be found.
         """
 
     def __getslice__(index1, index2):
-        """Return a subsequence from the original sequence
+        """Return a subsequence from the original sequence.
 
-        Such that the subsequence includes the items from index1 up
-        to, but not including, index2.
+        The subsequence includes the items from index1 up to, but not
+        including, index2.
         """
 
-
 class IKeyed(ICollection):
 
     def has_key(key):
@@ -55,7 +54,7 @@
     def keys(min=None, max=None, excludemin=False, excludemax=False):
         """Return an IReadSequence containing the keys in the collection.
 
-        The type of the IReadSequence is not specified. It could be a list
+        The type of the IReadSequence is not specified.  It could be a list
         or a tuple or some other type.
 
         All arguments are optional, and may be specified as keyword
@@ -75,17 +74,19 @@
         """
 
     def maxKey(key=None):
-        """Return the maximum key
+        """Return the maximum key.
 
-        If a key argument if provided, return the largest key that is
-        less than or equal to the argument.
+        If a key argument if provided and not None, return the largest key
+        that is less than or equal to the argument.  Raise an exception if
+        no such key exists.
         """
 
     def minKey(key=None):
-        """Return the minimum key
+        """Return the minimum key.
 
-        If a key argument if provided, return the smallest key that is
-        greater than or equal to the argument.
+        If a key argument if provided and not None, return the smallest key
+        that is greater than or equal to the argument.  Raise an exception
+        if no such key exists.
         """
 
 
@@ -131,24 +132,24 @@
 class IMinimalDictionary(ISized, IKeyed):
 
     def get(key, default):
-        """Get the value for the given key
+        """Get the value associated with the given key.
 
-        Return the default if the key is not in the collection.
+        Return the default if has_key(key) is false.
         """
 
     def __setitem__(key, value):
-        """Set the value for the given key."""
+        """Set the value associated with the given key."""
 
     def __delitem__(key):
-        """Delete the value for the given key.
+        """Delete the value associated with the given key.
 
-        Raise KeyError if the key if not in the collection.
+        Raise KeyError if the key if has_key(key) is false.
         """
 
     def values(min=None, max=None, excludemin=False, excludemax=False):
         """Return an IReadSequence containing the values in the collection.
 
-        The type of the IReadSequence is not specified. It could be a list
+        The type of the IReadSequence is not specified.  It could be a list
         or a tuple or some other type.
 
         All arguments are optional, and may be specified as keyword
@@ -200,20 +201,19 @@
     def update(collection):
         """Add the items from the given collection object to the collection.
 
-        The input collection must be a sequence of key-value tuples,
+        The input collection must be a sequence of (key, value) 2-tuples,
         or an object with an 'items' method that returns a sequence of
-        key-value tuples.
+        (key, value) pairs.
         """
 
     def byValue(minValue):
-        """Return a sequence of value-key pairs, sorted by value
+        """Return a sequence of (value, key) pairs, sorted by value.
 
-        Values < min are ommitted and other values are "normalized" by
-        the minimum value. This normalization may be a noop, but, for
+        Values < minValue are omitted and other values are "normalized" by
+        the minimum value.  This normalization may be a noop, but, for
         integer values, the normalization is division.
         """
 
-
 class IBTree(IDictionaryIsh):
 
     def insert(key, value):
@@ -230,7 +230,7 @@
 
         A standard idiom for generating new keys will be::
 
-          key=generate_key()
+          key = generate_key()
           while not t.insert(key, value):
               key=generate_key()
         """
@@ -255,8 +255,7 @@
     """
 
     def difference(c1, c2):
-        """Return the keys or items in c1 for which there is no key in
-        c2.
+        """Return the keys or items in c1 for which there is no key in c2.
 
         If c1 is None, then None is returned.  If c2 is None, then c1
         is returned.