Document close on '__del__' behavior of closer.

1 files changed, 6 insertions, 4 deletions

diff --git a/repoze/bfg/scripting.py b/repoze/bfg/scripting.py
index 5399b7d77..5694a8006 100644
--- a/repoze/bfg/scripting.py
+++ b/repoze/bfg/scripting.py
@@ -4,10 +4,12 @@ def get_root(app, environ=None):
     The ``root`` returned is the application root object.  The
     ``closer`` returned is a callable (accepting no arguments) that
     should be called when your scripting application is finished using
-    the root.  If ``environ`` is not None, it is used as the
-    environment passed to the BFG application root factory.  An empty
-    environ is constructed and passed to the root factory if
-    ``environ`` is None."""
+    the root.  The closer also closes the db connection when its ``__del__``
+    method is called.  This means the connection can also be closed by 
+    explicitly deleting the closer using ``del`` or, more commonly,  letting 
+    it fall out of scope.  If ``environ`` is not None, it is used as the 
+    environment passed to the BFG application root factory.  An empty environ 
+    is constructed and passed to the root factory if ``environ`` is None."""
     registry = app.registry
     threadlocals = {'registry':registry, 'request':None}
     app.threadlocal_manager.push(threadlocals)