Skip to content

Commit 781d76c

Browse files
committed
Reformat docstring for _Pointer::__init__
1 parent 69b8a77 commit 781d76c

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

roundup/hyperdb.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,12 +188,16 @@ class _Pointer(_Type):
188188
def __init__(self, classname, do_journal='yes', try_id_parsing='yes',
189189
required=False, default_value=None,
190190
msg_header_property=None, quiet=False, rev_multilink=None):
191-
""" Default is to journal link and unlink events.
191+
""" The base class used by Link and Multilink classes.
192+
193+
Default is to journal link and unlink events.
194+
192195
When try_id_parsing is false, we don't allow IDs in input
193196
fields (the key of the Link or Multilink property must be
194197
given instead). This is useful when the name of a property
195198
can be numeric. It will only work if the linked item has a
196199
key property and is a questionable feature for multilinks.
200+
197201
The msg_header_property is used in the mail gateway when
198202
sending out messages: By default roundup creates headers of
199203
the form: 'X-Roundup-issue-prop: value' for all properties
@@ -205,6 +209,7 @@ def __init__(self, classname, do_journal='yes', try_id_parsing='yes',
205209
'msg_header_property="username"' for the assigned_to
206210
property will generated message headers of the form:
207211
'X-Roundup-issue-assigned_to: joe_user'.
212+
208213
The rev_multilink is used to inject a reverse multilink into
209214
the Class linked by a Link or Multilink property. Note that
210215
the result is always a Multilink. The name given with

0 commit comments

Comments
 (0)