From: Fred Drake <fdrake@acm.org>
Date: Tue, 22 Dec 1998 18:04:48 +0000 (+0000)
Subject: Add an explanation about what the example does and doesn't do.
X-Git-Tag: v1.5.2b1~12
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=7be0cde3a0976099214f03c119a640e3e73d0d94;p=python

Add an explanation about what the example does and doesn't do.

Fix an appearantly new behavior with latex2html with quoting.  (Good
incentive to work on the SGML conversion! ;)
---

diff --git a/Doc/lib/libsmtplib.tex b/Doc/lib/libsmtplib.tex
index de295a15ec..21c222515f 100644
--- a/Doc/lib/libsmtplib.tex
+++ b/Doc/lib/libsmtplib.tex
@@ -134,7 +134,12 @@ consult the module code.
 
 \subsection{SMTP Example \label{SMTP-example}}
 
-% really need a little description here...
+This example prompts the user for addresses needed in the message
+envelop (`To' and `From' addresses), and the message to be
+delivered.  Note that the headers to be included with the message must 
+be included in the message as entered; this example doesn't do any
+processing of the \rfc{822} headers.  In particular, the `To' and
+`From' addresses must be included in the message headers explicitly.
 
 \begin{verbatim}
 import rfc822, string, sys
@@ -147,7 +152,7 @@ def prompt(prompt):
 fromaddr = prompt("From")
 toaddrs  = string.splitfields(prompt("To"), ',')
 print "Enter message, end with ^D:"
-msg = ''
+msg = ""
 while 1:
     line = sys.stdin.readline()
     if not line: