diff roundup/roundupdb.py @ 2005:fc52d57c6c3e

documentation cleanup
author Richard Jones <richard@users.sourceforge.net>
date Wed, 11 Feb 2004 23:55:10 +0000
parents 3fa6df0d120d
children be047db3dd3d
line wrap: on
line diff
--- a/roundup/roundupdb.py	Wed Feb 11 21:34:31 2004 +0000
+++ b/roundup/roundupdb.py	Wed Feb 11 23:55:10 2004 +0000
@@ -15,11 +15,12 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: roundupdb.py,v 1.96 2003-12-05 04:43:30 richard Exp $
+# $Id: roundupdb.py,v 1.97 2004-02-11 23:55:08 richard Exp $
 
-__doc__ = """
-Extending hyperdb with types specific to issue-tracking.
+"""Extending hyperdb with types specific to issue-tracking.
 """
+__docformat__ = 'restructuredtext'
+
 from __future__ import nested_scopes
 
 import re, os, smtplib, socket, time, random
@@ -95,15 +96,16 @@
 
 # deviation from spec - was called IssueClass
 class IssueClass:
-    """ This class is intended to be mixed-in with a hyperdb backend
-        implementation. The backend should provide a mechanism that
-        enforces the title, messages, files, nosy and superseder
-        properties:
-            properties['title'] = hyperdb.String(indexme='yes')
-            properties['messages'] = hyperdb.Multilink("msg")
-            properties['files'] = hyperdb.Multilink("file")
-            properties['nosy'] = hyperdb.Multilink("user")
-            properties['superseder'] = hyperdb.Multilink(classname)
+    """This class is intended to be mixed-in with a hyperdb backend
+    implementation. The backend should provide a mechanism that
+    enforces the title, messages, files, nosy and superseder
+    properties:
+
+    - title = hyperdb.String(indexme='yes')
+    - messages = hyperdb.Multilink("msg")
+    - files = hyperdb.Multilink("file")
+    - nosy = hyperdb.Multilink("user")
+    - superseder = hyperdb.Multilink(classname)
     """
 
     # New methods:

Roundup Issue Tracker: http://roundup-tracker.org/