[Checkins] SVN: zc.intid/trunk/ more documentation

[Fred Drake]

Log message for revision 105908:
  more documentation

Changed:
  U   zc.intid/trunk/README.txt
  U   zc.intid/trunk/src/zc/intid/__init__.py

-=-
Modified: zc.intid/trunk/README.txt
===================================================================
--- zc.intid/trunk/README.txt	2009-11-20 14:33:10 UTC (rev 105907)
+++ zc.intid/trunk/README.txt	2009-11-20 14:44:47 UTC (rev 105908)
@@ -14,7 +14,11 @@
 attribute of the object itself, with the attribute name being configured
 by the construction of the id utility.
 
+Events generated on the assignment and removal of ids are generated by
+the ``register`` and ``unregister`` methods rather than by the callers
+of those methods.
 
+
 Changes
 =======
 

Modified: zc.intid/trunk/src/zc/intid/__init__.py
===================================================================
--- zc.intid/trunk/src/zc/intid/__init__.py	2009-11-20 14:33:10 UTC (rev 105907)
+++ zc.intid/trunk/src/zc/intid/__init__.py	2009-11-20 14:44:47 UTC (rev 105908)
@@ -50,12 +50,20 @@
         """Register an object and returns a unique id generated for it.
 
         If the object is already registered, its id is returned anyway.
+
+        If not already registered, the registration is made and an
+        ``IIdAddedEvent`` is generated.
+
         """
 
     def unregister(ob):
         """Remove the object from the indexes.
 
         KeyError is raised if ob is not registered previously.
+
+        An ``IIdRemovedEvent`` is triggered for successful
+        unregistrations.
+
         """
 
 class IIntIdsManage(zope.interface.Interface):