Mercurial > p > roundup > code
comparison roundup/hyperdb.py @ 7526:b8dc16d9624a
Reformat docstring for _Pointer::__init__
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 10 Jul 2023 00:39:32 -0400 |
| parents | 76a21cf791b9 |
| children | 14a8e11f3a87 f7bd22bdef9d |
comparison
equal
deleted
inserted
replaced
| 7524:6dc0f7afde80 | 7526:b8dc16d9624a |
|---|---|
| 186 """An object designating a Pointer property that links or multilinks | 186 """An object designating a Pointer property that links or multilinks |
| 187 to a node in a specified class.""" | 187 to a node in a specified class.""" |
| 188 def __init__(self, classname, do_journal='yes', try_id_parsing='yes', | 188 def __init__(self, classname, do_journal='yes', try_id_parsing='yes', |
| 189 required=False, default_value=None, | 189 required=False, default_value=None, |
| 190 msg_header_property=None, quiet=False, rev_multilink=None): | 190 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 | |
| 192 When try_id_parsing is false, we don't allow IDs in input | 195 When try_id_parsing is false, we don't allow IDs in input |
| 193 fields (the key of the Link or Multilink property must be | 196 fields (the key of the Link or Multilink property must be |
| 194 given instead). This is useful when the name of a property | 197 given instead). This is useful when the name of a property |
| 195 can be numeric. It will only work if the linked item has a | 198 can be numeric. It will only work if the linked item has a |
| 196 key property and is a questionable feature for multilinks. | 199 key property and is a questionable feature for multilinks. |
| 200 | |
| 197 The msg_header_property is used in the mail gateway when | 201 The msg_header_property is used in the mail gateway when |
| 198 sending out messages: By default roundup creates headers of | 202 sending out messages: By default roundup creates headers of |
| 199 the form: 'X-Roundup-issue-prop: value' for all properties | 203 the form: 'X-Roundup-issue-prop: value' for all properties |
| 200 prop of issue that have a 'name' property. This definition | 204 prop of issue that have a 'name' property. This definition |
| 201 allows to override the 'name' property. A common use-case is | 205 allows to override the 'name' property. A common use-case is |
| 203 user mail-filtering of issue-emails for which they're | 207 user mail-filtering of issue-emails for which they're |
| 204 responsible. In that case setting | 208 responsible. In that case setting |
| 205 'msg_header_property="username"' for the assigned_to | 209 'msg_header_property="username"' for the assigned_to |
| 206 property will generated message headers of the form: | 210 property will generated message headers of the form: |
| 207 'X-Roundup-issue-assigned_to: joe_user'. | 211 'X-Roundup-issue-assigned_to: joe_user'. |
| 212 | |
| 208 The rev_multilink is used to inject a reverse multilink into | 213 The rev_multilink is used to inject a reverse multilink into |
| 209 the Class linked by a Link or Multilink property. Note that | 214 the Class linked by a Link or Multilink property. Note that |
| 210 the result is always a Multilink. The name given with | 215 the result is always a Multilink. The name given with |
| 211 rev_multilink is the name in the class where it is injected. | 216 rev_multilink is the name in the class where it is injected. |
| 212 """ | 217 """ |