Mercurial > p > roundup > code
changeset 7526:b8dc16d9624a
Reformat docstring for _Pointer::__init__
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 10 Jul 2023 00:39:32 -0400 |
| parents | 6dc0f7afde80 |
| children | b8f012c7c5a7 |
| files | roundup/hyperdb.py |
| diffstat | 1 files changed, 6 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/roundup/hyperdb.py Thu Jul 06 19:57:15 2023 -0400 +++ b/roundup/hyperdb.py Mon Jul 10 00:39:32 2023 -0400 @@ -188,12 +188,16 @@ def __init__(self, classname, do_journal='yes', try_id_parsing='yes', required=False, default_value=None, msg_header_property=None, quiet=False, rev_multilink=None): - """ Default is to journal link and unlink events. + """ The base class used by Link and Multilink classes. + + Default is to journal link and unlink events. + When try_id_parsing is false, we don't allow IDs in input fields (the key of the Link or Multilink property must be given instead). This is useful when the name of a property can be numeric. It will only work if the linked item has a key property and is a questionable feature for multilinks. + The msg_header_property is used in the mail gateway when sending out messages: By default roundup creates headers of the form: 'X-Roundup-issue-prop: value' for all properties @@ -205,6 +209,7 @@ 'msg_header_property="username"' for the assigned_to property will generated message headers of the form: 'X-Roundup-issue-assigned_to: joe_user'. + The rev_multilink is used to inject a reverse multilink into the Class linked by a Link or Multilink property. Note that the result is always a Multilink. The name given with
