From: richard <richard@57a73879-2fb5-44c3-a270-3262357dd7e2>
Date: Mon, 12 Jul 2010 04:02:14 +0000 (+0000)
Subject: doc tweak
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=d385d8a29648904145a9d7b7eec6b5b2250f7737;p=roundup.git

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 6b0f09a..fcb900d 100644
--- 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'