Emphasize that the object passed to set_data and data is the object n…

…eedeing the data And that it's id is used.
zopefoundation · May 21, 2016 · 810f847 · 810f847
1 parent a9c8bcf
commit 810f847
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/transaction/interfaces.py b/transaction/interfaces.py
@@ -306,6 +306,10 @@ def set_data(self, object, data):
         transaction-specific data on the transaction itself.  The
         transaction knows nothing about the data, but simply holds it
         on behalf of the object.
+
+        The object passed should be the object that needs the data, as
+        opposed to simple object like a string. (Internally, the id of
+        the object is used as the key.)
         """
 
     def data(self, object):