Skip to content

Commit 56cb0ad

Browse files
committed
clarify doc on dispatcher_email config setting.
An issue was brought up on the mailing list. https://sourceforge.net/p/roundup/mailman/message/43383465/ The description of dispatcher_email sounds like it should be sent email on issue creation. That's not it's role. Try to make it's role more obvious. Fix config.ini and reference.txt description. Add the newissuecopy.py detector to send email on the creation of an issue
1 parent d24abce commit 56cb0ad

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

doc/reference.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,10 @@ Section **main**
144144
below is used.
145145

146146
dispatcher_email -- ``roundup-admin``
147-
The 'dispatcher' is a role that can get notified of new items to the
148-
database. It is used by the ERROR_MESSAGES_TO config setting. If the
149-
email address doesn't contain an ``@`` part, the MAIL_DOMAIN defined
150-
below is used.
147+
The 'dispatcher' is a role that can get notified when errors occur
148+
while sending email to a user. It is used by the ERROR_MESSAGES_TO config
149+
setting. If the email address doesn't contain an ``@`` part, the
150+
MAIL_DOMAIN defined below is used.
151151

152152
email_from_tag -- default *blank*
153153
Additional text to include in the "name" part of the From: address used

roundup/configuration.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1026,7 +1026,7 @@ def str2value(self, value):
10261026
"mail -> domain is added."),
10271027
(MailAddressOption, "dispatcher_email", "roundup-admin",
10281028
"The 'dispatcher' is a role that can get notified\n"
1029-
"of new items to the database.\n"
1029+
"when errors occur while sending email to a user.\n"
10301030
"It is used by the ERROR_MESSAGES_TO config setting.\n"
10311031
"If no domain is specified then the config item\n"
10321032
"mail -> domain is added."),

0 commit comments

Comments
 (0)