[Python-checkins] CVS: python/dist/src/Doc/lib librfc822.tex,1.30,1.31

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Doc/lib
In directory usw-pr-cvs1:/tmp/cvs-serv24275/lib

Modified Files:
	librfc822.tex 
Log Message:

Fix a number of bugs and omissions in the AddressList documentation, most
noted by Steve Holden.


This closes SF bug #413876.


Index: librfc822.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/lib/librfc822.tex,v
retrieving revision 1.30
retrieving revision 1.31
diff -C2 -r1.30 -r1.31
*** librfc822.tex	2001/01/27 10:56:14	1.30
--- librfc822.tex	2001/04/09 15:42:56	1.31
***************
*** 239,262 ****
  An \class{AddressList} instance has the following methods:
  
! \begin{methoddesc}{__len__}{name}
  Return the number of addresses in the address list.
  \end{methoddesc}
  
! \begin{methoddesc}{__str__}{name}
  Return a canonicalized string representation of the address list.
  Addresses are rendered in "name" <host@domain> form, comma-separated.
  \end{methoddesc}
  
! \begin{methoddesc}{__add__}{name}
! Return an \class{AddressList} instance that contains all addresses in
! both \class{AddressList} operands, with duplicates removed (set union).
  \end{methoddesc}
  
! \begin{methoddesc}{__sub__}{name}
! Return an \class{AddressList} instance that contains every address in the
! left-hand \class{AddressList} operand that is not present in the right-hand
! address operand (set difference).
  \end{methoddesc}
  
  
  Finally, \class{AddressList} instances have one public instance variable:
--- 239,274 ----
  An \class{AddressList} instance has the following methods:
  
! \begin{methoddesc}{__len__}{}
  Return the number of addresses in the address list.
  \end{methoddesc}
  
! \begin{methoddesc}{__str__}{}
  Return a canonicalized string representation of the address list.
  Addresses are rendered in "name" <host@domain> form, comma-separated.
  \end{methoddesc}
  
! \begin{methoddesc}{__add__}{alist}
! Return a new \class{AddressList} instance that contains all addresses
! in both \class{AddressList} operands, with duplicates removed (set
! union).
  \end{methoddesc}
  
! \begin{methoddesc}{__iadd__}{alist}
! In-place version of \method{__add__()}; turns this \class{AddressList}
! instance into the union of itself and the right-hand instance,
! \var{alist}.
  \end{methoddesc}
  
+ \begin{methoddesc}{__sub__}{alist}
+ Return a new \class{AddressList} instance that contains every address
+ in the left-hand \class{AddressList} operand that is not present in
+ the right-hand address operand (set difference).
+ \end{methoddesc}
+ 
+ \begin{methoddesc}{__isub__}{alist}
+ In-place version of \method{__sub__()}, removing addresses in this
+ list which are also in \var{alist}.
+ \end{methoddesc}
+ 
  
  Finally, \class{AddressList} instances have one public instance variable:
***************
*** 265,268 ****
  A list of tuple string pairs, one per address.  In each member, the
  first is the canonicalized name part, the second is the
! actual route-address (@-separated username-host.domain pair).
  \end{memberdesc}
--- 277,281 ----
  A list of tuple string pairs, one per address.  In each member, the
  first is the canonicalized name part, the second is the
! actual route-address (\character{@}-separated username-host.domain
! pair).
  \end{memberdesc}