# User Aurelien Campeas <email@example.com>
# Date 1404213575 -7200
# Tue Jul 01 13:19:35 2014 +0200
# Node ID 52a976c5d27a7c75f0146f55db357cc85f5aeef3
# Parent b926ff4ef4a8ab3c647d96f8274a11099a9b9e11
[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.
1 of 'read' (connections set may be freed), 'write' (some write was done in 2 the connections set, it can't be freed before end of the transaction), 3 'transaction' (we want to keep the connections set during all the 4 transaction, with or without writing) 5 6 - Internal transaction data: 7 + Shared data: 8 9 - :attr:`data` is a dictionary containing some shared data 10 - cleared at the end of the transaction. Hooks and operations may put 11 - arbitrary data in there, and this may also be used as a communication 12 - channel between the client and the repository. 13 + :attr:`data` is a dictionary bound to the underlying session, 14 + who will be present for the life time of the session. This may 15 + be useful for web clients that rely on the server for managing 16 + bits of session-scoped data. 17 + 18 + :attr:`transaction_data` is a dictionary cleared at the end of 19 + the transaction. Hooks and operations may put arbitrary data in 20 + there. 21 + 22 + Internal state: 23 24 :attr:`pending_operations`, ordered list of operations to be processed on 25 commit/rollback 26 27 :attr:`commit_state`, describing the transaction commit state, may be one