[Python-checkins] python/dist/src/Lib/email Message.py,1.22,1.23

[bwarsaw@users.sourceforge.net]

Update of /cvsroot/python/python/dist/src/Lib/email
In directory usw-pr-cvs1:/tmp/cvs-serv843

Modified Files:
	Message.py 
Log Message:
get_payload(): Document that calling it with no arguments returns a
reference to the payload.


Index: Message.py
===================================================================
RCS file: /cvsroot/python/python/dist/src/Lib/email/Message.py,v
retrieving revision 1.22
retrieving revision 1.23
diff -C2 -d -r1.22 -r1.23
*** Message.py	6 Sep 2002 03:55:04 -0000	1.22
--- Message.py	11 Sep 2002 14:11:35 -0000	1.23
***************
*** 151,156 ****
  
      def get_payload(self, i=None, decode=0):
!         """Return the current payload exactly as is.
  
          Optional i returns that index into the payload.
  
--- 151,158 ----
  
      def get_payload(self, i=None, decode=0):
!         """Return a reference to the payload.
  
+         The payload is typically either a list object or a string.  If you
+         mutate the list object, you modify the message's payload in place.
          Optional i returns that index into the payload.
  
***************
*** 180,184 ****
          # unchanged.
          return payload
- 
  
      def set_payload(self, payload, charset=None):
--- 182,185 ----