doc tweak

git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/roundup/trunk@4494 57a73879-2fb5-44c3-a270-3262357dd7e2

diff --git a/roundup/instance.py b/roundup/instance.py
index 6b0f09a3b767dc7fab70e42ed515d32625d12fef..fcb900d683bd5e72df33a318500d46a4ba190936 100644 (file)
--- a/roundup/instance.py
+++ b/roundup/instance.py
@@ -16,9 +16,15 @@
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 #
 
-"""Tracker handling (open tracker).
+"""Top-level tracker interface.
 
-Backwards compatibility for the old-style "imported" trackers.
+Open a tracker with:
+
+    >>> from roundup import instance
+    >>> db = instance.open('path to tracker home')
+
+The "db" handle you get back is the tracker's hyperdb which has the interface
+desciribed in `roundup.hyperdb.Database`.
 """
 __docformat__ = 'restructuredtext'