From 810f8473dd6eaf69ed8bcb1a8864515721ceae6d Mon Sep 17 00:00:00 2001 From: Jim Fulton Date: Sat, 21 May 2016 16:07:35 -0400 Subject: [PATCH] Emphasize that the object passed to set_data and data is the object needeing the data And that it's id is used. --- transaction/interfaces.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/transaction/interfaces.py b/transaction/interfaces.py index ff6671a..25b1146 100644 --- 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):