Ticket #699 (closed defect: fixed)

Opened 5 weeks ago

Last modified 5 weeks ago

confusing wording in mail.MailNotifier.__init__ documentation

Reported by: VZ Owned by: krajaratnam
Priority: trivial Milestone: 0.8.0
Version: 0.7.11 Keywords: documentation mailnotifier
Cc:

Description

The extraRecipients parameter is currently described as tuple of string but it should really be a list of strings because sort() is called on it later in the code and tuples, unlike lists, don't have this method.

Maybe it's just me, of course, and you're not supposed to interpret "tuple" here as meaning Python "tuple" but I did (even patting myself on the head for noticing that this one parameter was a tuple unlike everything else...) and IMO it's not impossible that someone else will be trapped by this as well, hence it would be better to avoid mentioning tuples here at all.

Change History

Changed 5 weeks ago by krajaratnam

  • owner set to krajaratnam
  • status changed from new to assigned

Changed 5 weeks ago by krajaratnam

  • milestone changed from undecided to 0.8.0

Changed 5 weeks ago by krajaratnam

  • status changed from assigned to closed
  • resolution set to fixed

Thanks for reporting.

Fixed in changeset: 9522a0e52bfb222d85c3f04e1cb0909a5bd8714a

Note: See TracTickets for help on using tickets.