[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.

authorAurelien Campeas <aurelien.campeas@logilab.fr>
changeset037ee2fad84e
branchdefault
phasedraft
hiddenyes
parent revision#2099318fc047 [repoapi,session] remove all session-as-cnx backward compat
child revision#fa261a1315bc [connection] replace .running_dbapi_query with .direct_query
files modified by this revision
server/session.py
# HG changeset patch
# User Aurelien Campeas <aurelien.campeas@logilab.fr>
# Date 1404213575 -7200
# Tue Jul 01 13:19:35 2014 +0200
# Node ID 037ee2fad84e75d27a09996ecb35fee5c02e9491
# Parent 2099318fc0474ceb0dcde498e269f97e8f9be4c2
[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.

diff --git a/server/session.py b/server/session.py
@@ -403,16 +403,22 @@
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