[Trac-tickets] [The Trac Project] #2887: confusing TracNotification documentation

[The Trac Project]

#2887: confusing TracNotification documentation
----------------------------+-----------------------------------------------
 Reporter:  yoav at tuzig.com  |       Owner:  jonas
     Type:  enhancement     |      Status:  new  
 Priority:  low             |   Milestone:       
Component:  ticket system   |     Version:  0.9.4
 Severity:  minor           |    Keywords:       
----------------------------+-----------------------------------------------
 Hi there,

 We've started using trac not too long ago and in the process of
 configuring the SMTP notification I noticed some confusing paragraphs in
 the TracNotification documentation.

 First of all, the documentation says "When reporting a new ticket or
 adding a comment, enter a ''valid email address'' in the reporter,
 assigned to/owner or cc field. Trac will automatically send you an email
 when changes are made to the ticket"

 But in fact it doesn't require an email address but a trac user (with an
 associated email address). What happened to me when trying it out was that
 a new user was linked to a ticket if I put the email address (our
 usernames don't have @domain)

 Secondly, always_notify_reporter, always_notify_owner etc are very
 confusing names, because they actually mean notify_reporter,
 notify_owner...

 Reading the guidelines I assumed if you just put the username it wouldn't
 send notification, but if you do then it will - regardless of the
 always_notify_xxx settings. i.e. Users can control whether they are
 notified on a ticket-by-ticket basis. I thought the alwyas_notify is used
 to FORCE notification even when an email is not typed in.

 I think the documentation should be more clear about it. Maybe I'm the
 only one with reading difficulties ;-)

 Thanks
 Yoav

-- 
Ticket URL: <http://projects.edgewall.com/trac/ticket/2887>
The Trac Project <http://trac.edgewall.com/>