Docs for dataclass_utils.

[pyutils.git] / docs / pyutils.collectionz.rst

diff --git a/docs/pyutils.collectionz.rst b/docs/pyutils.collectionz.rst
index e0632afdbc3be35fc16657532065ed07646b57f4..0b0123797f7cfa159ea5b0f58aebed67830a3347 100644 (file)
--- a/docs/pyutils.collectionz.rst
+++ b/docs/pyutils.collectionz.rst
@@ -1,18 +1,18 @@
 pyutils.collectionz package
 ===========================
 
+This subpackage contains some homegrown collections that try to emulate
+:mod:`collections` included in the Python standard library.  It ends
+with a 'z' so as not to collide with the standard library package.
+
 Submodules
 ----------
 
 pyutils.collectionz.bidict module
 ---------------------------------
 
-The bidict.BiDict class is a bidirectional dictionary.  It maps each
-key to a value in constant time and each value back to the one or more
-keys it is associated with in constant time.  It does this by simply
-storing the data twice.
-
 .. automodule:: pyutils.collectionz.bidict
+   :imported-members:
    :members:
    :undoc-members:
    :show-inheritance:
@@ -20,8 +20,6 @@ storing the data twice.
 pyutils.collectionz.bst module
 ------------------------------
 
-The bst.BinarySearchTree class is a binary search tree container.
-
 .. automodule:: pyutils.collectionz.bst
    :members:
    :undoc-members:
@@ -46,13 +44,6 @@ size.
 pyutils.collectionz.trie module
 -------------------------------
 
-The trie.Trie class is a Trie or prefix tree.  It can be used with
-arbitrary sequences as keys and stores its values in a tree with paths
-determined by the sequence determined by each key.  Thus, it can
-determine whether a value is contained in the tree via a simple
-traversal in linear time and can also check whether a key-prefix is
-present in the tree in linear time.
-
 .. automodule:: pyutils.collectionz.trie
    :members:
    :undoc-members: