[Buildbot-commits] [SPAM] [Buildbot] #699: confusing wording in mail.MailNotifier.__init__ documentation

[Buildbot]

#699: confusing wording in mail.MailNotifier.__init__ documentation
--------------------+-------------------------------------------------------
Reporter:  VZ       |       Owner:                            
    Type:  defect   |      Status:  new                       
Priority:  trivial  |   Milestone:  undecided                 
 Version:  0.7.11   |    Keywords:  documentation mailnotifier
--------------------+-------------------------------------------------------
 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.

-- 
Ticket URL: <http://buildbot.net/trac/ticket/699>
Buildbot <http://buildbot.net/>
Buildbot: build/test automation