From d385d8a29648904145a9d7b7eec6b5b2250f7737 Mon Sep 17 00:00:00 2001 From: richard Date: Mon, 12 Jul 2010 04:02:14 +0000 Subject: [PATCH] doc tweak git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/roundup/trunk@4494 57a73879-2fb5-44c3-a270-3262357dd7e2 --- roundup/instance.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) 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' -- 2.30.2