Update documentation.

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

diff --git a/docs/pyutils.collectionz.rst b/docs/pyutils.collectionz.rst
index c3424503628c6c817a46203a42aefa903851ae4d..0b0123797f7cfa159ea5b0f58aebed67830a3347 100644 (file)
--- a/docs/pyutils.collectionz.rst
+++ b/docs/pyutils.collectionz.rst
@@ -1,6 +1,10 @@
 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
 ----------
 
@@ -8,6 +12,7 @@ pyutils.collectionz.bidict module
 ---------------------------------
 
 .. automodule:: pyutils.collectionz.bidict
+   :imported-members:
    :members:
    :undoc-members:
    :show-inheritance:
@@ -23,6 +28,14 @@ pyutils.collectionz.bst module
 pyutils.collectionz.shared\_dict module
 ---------------------------------------
 
+The shared\_dict.SharedDict class is a normal python dictionary that
+can be accessed safely in parallel from multiple threads or processes
+without (external) locking by using Multiprocessing.SharedMemory.  It
+uses internal locking and rewrites the shared memory region as it is
+changed so it is slower than a normal dict.  It also does not grow
+dynamically; the creator of the shared\_dict must declare a maximum
+size.
+
 .. automodule:: pyutils.collectionz.shared_dict
    :members:
    :undoc-members: