From 9efda29d60ae83d17bce793e0a23e3ec43c67f80 Mon Sep 17 00:00:00 2001 From: Jason Gerard DeRose Date: Sat, 24 Jan 2009 22:44:58 -0700 Subject: Added docstring to Connectible class --- ipalib/backend.py | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'ipalib/backend.py') diff --git a/ipalib/backend.py b/ipalib/backend.py index bb8d31012..f2741abec 100644 --- a/ipalib/backend.py +++ b/ipalib/backend.py @@ -36,6 +36,14 @@ class Backend(plugable.Plugin): class Connectible(Backend): + """ + Base class for backend plugins that create connections. + + In addition to the nicety of providing a standard connection API, all + backend plugins that create connections should use this base class so that + `request.destroy_context()` can properly close all open connections. + """ + def connect(self, *args, **kw): """ Create thread-local connection. -- cgit