comparison 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
comparison
equal deleted inserted replaced
2004:1782fe36e7b8 2005:fc52d57c6c3e
13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 13 # BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS" 14 # FOR A PARTICULAR PURPOSE. THE CODE PROVIDED HEREUNDER IS ON AN "AS IS"
15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE, 15 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. 16 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
17 # 17 #
18 # $Id: roundupdb.py,v 1.96 2003-12-05 04:43:30 richard Exp $ 18 # $Id: roundupdb.py,v 1.97 2004-02-11 23:55:08 richard Exp $
19 19
20 __doc__ = """ 20 """Extending hyperdb with types specific to issue-tracking.
21 Extending hyperdb with types specific to issue-tracking.
22 """ 21 """
22 __docformat__ = 'restructuredtext'
23
23 from __future__ import nested_scopes 24 from __future__ import nested_scopes
24 25
25 import re, os, smtplib, socket, time, random 26 import re, os, smtplib, socket, time, random
26 import cStringIO, base64, quopri, mimetypes 27 import cStringIO, base64, quopri, mimetypes
27 28
93 """ 94 """
94 pass 95 pass
95 96
96 # deviation from spec - was called IssueClass 97 # deviation from spec - was called IssueClass
97 class IssueClass: 98 class IssueClass:
98 """ This class is intended to be mixed-in with a hyperdb backend 99 """This class is intended to be mixed-in with a hyperdb backend
99 implementation. The backend should provide a mechanism that 100 implementation. The backend should provide a mechanism that
100 enforces the title, messages, files, nosy and superseder 101 enforces the title, messages, files, nosy and superseder
101 properties: 102 properties:
102 properties['title'] = hyperdb.String(indexme='yes') 103
103 properties['messages'] = hyperdb.Multilink("msg") 104 - title = hyperdb.String(indexme='yes')
104 properties['files'] = hyperdb.Multilink("file") 105 - messages = hyperdb.Multilink("msg")
105 properties['nosy'] = hyperdb.Multilink("user") 106 - files = hyperdb.Multilink("file")
106 properties['superseder'] = hyperdb.Multilink(classname) 107 - nosy = hyperdb.Multilink("user")
108 - superseder = hyperdb.Multilink(classname)
107 """ 109 """
108 110
109 # New methods: 111 # New methods:
110 def addmessage(self, nodeid, summary, text): 112 def addmessage(self, nodeid, summary, text):
111 """Add a message to an issue's mail spool. 113 """Add a message to an issue's mail spool.

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