From ba0267a955d40efb09de06ce226fbab63994aa78 Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Tue, 18 Dec 2007 23:53:40 +0000 Subject: introductory docstring bonanza --- lib/sqlalchemy/engine/threadlocal.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'lib/sqlalchemy/engine/threadlocal.py') diff --git a/lib/sqlalchemy/engine/threadlocal.py b/lib/sqlalchemy/engine/threadlocal.py index 6122b61b2..d07d8da83 100644 --- a/lib/sqlalchemy/engine/threadlocal.py +++ b/lib/sqlalchemy/engine/threadlocal.py @@ -1,12 +1,13 @@ -from sqlalchemy import util -from sqlalchemy.engine import base - """Provides a thread-local transactional wrapper around the root Engine class. -Provides begin/commit methods on the engine itself which correspond to -a thread-local transaction. +The ``threadlocal`` module is invoked when using the ``strategy="threadlocal"`` flag +with [sqlalchemy.engine#create_engine()]. This module is semi-private and is +invoked automatically when the threadlocal engine strategy is used. """ +from sqlalchemy import util +from sqlalchemy.engine import base + class TLSession(object): def __init__(self, engine): self.engine = engine -- cgit v1.2.1