[connection] provide some missing documentation bits
authorAurelien Campeas <aurelien.campeas@logilab.fr>
Tue, 01 Jul 2014 13:19:35 +0200
changeset 10347 52a976c5d27a
parent 10346 b926ff4ef4a8
child 10349 efbbf1e93a04
[connection] provide some missing documentation bits The previous changesets remove information about session data and transaction data. We provide the necessary entries in the docstring of the Connection class. Related to #3933480.
server/session.py
--- a/server/session.py	Fri Jun 06 17:08:08 2014 +0200
+++ b/server/session.py	Tue Jul 01 13:19:35 2014 +0200
@@ -405,12 +405,18 @@
       'transaction' (we want to keep the connections set during all the
       transaction, with or without writing)
 
-    Internal transaction data:
+    Shared data:
 
-      :attr:`data` is a dictionary containing some shared data
-      cleared at the end of the transaction. Hooks and operations may put
-      arbitrary data in there, and this may also be used as a communication
-      channel between the client and the repository.
+      :attr:`data` is a dictionary bound to the underlying session,
+      who will be present for the life time of the session. This may
+      be useful for web clients that rely on the server for managing
+      bits of session-scoped data.
+
+      :attr:`transaction_data` is a dictionary cleared at the end of
+      the transaction. Hooks and operations may put arbitrary data in
+      there.
+
+    Internal state:
 
       :attr:`pending_operations`, ordered list of operations to be processed on
       commit/rollback