Cleaned up documentation for connection status constants.

Dropped reference to unused/internal states.
This commit is contained in:
Daniele Varrazzo 2010-04-23 11:41:31 +01:00
parent cb40342afa
commit dab098c1cb

View File

@ -427,30 +427,23 @@ Connection status constants
These values represent the possible status of a connection: the current value
can be read from the `~connection.status` attribute.
.. data:: STATUS_SETUP
Used internally.
It is possible to find the connection in other status than the one shown below.
Those are the only states in which a working connection is expected to be found
during the execution of regular Python client code: other states are for
internal usage and Python code should not rely on them.
.. data:: STATUS_READY
Connection established.
Connection established. No transaction in progress.
.. data:: STATUS_BEGIN
Connection established. A transaction is in progress.
Connection established. A transaction is currently in progress.
.. data:: STATUS_IN_TRANSACTION
An alias for `STATUS_BEGIN`
.. data:: STATUS_SYNC
Used internally.
.. data:: STATUS_ASYNC
Used internally.
.. index::