Skip to content

Commit a35068b

Browse files
author
Richard Jones
committed
doc tweak
1 parent 4f3f38c commit a35068b

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

roundup/instance.py

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,15 @@
1616
# SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
1717
#
1818

19-
"""Tracker handling (open tracker).
19+
"""Top-level tracker interface.
2020
21-
Backwards compatibility for the old-style "imported" trackers.
21+
Open a tracker with:
22+
23+
>>> from roundup import instance
24+
>>> db = instance.open('path to tracker home')
25+
26+
The "db" handle you get back is the tracker's hyperdb which has the interface
27+
desciribed in `roundup.hyperdb.Database`.
2228
"""
2329
__docformat__ = 'restructuredtext'
2430

0 commit comments

Comments
 (0)