summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2007-08-24 17:23:23 (GMT)
committerGeorg Brandl <georg@python.org>2007-08-24 17:23:23 (GMT)
commit94bda3a586e1282dc311ab93b1642cee83b7e5e0 (patch)
tree11eb4ab3851420bb18a3fe77ae25f30a979a96ba
parent966bb8c59bb2a072c230fa0c6459b3ac3d52b9f3 (diff)
downloadcpython-94bda3a586e1282dc311ab93b1642cee83b7e5e0.zip
cpython-94bda3a586e1282dc311ab93b1642cee83b7e5e0.tar.gz
cpython-94bda3a586e1282dc311ab93b1642cee83b7e5e0.tar.bz2
Bug #1011: fix rfc822.Message.getheader docs.
-rw-r--r--Doc/library/rfc822.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/Doc/library/rfc822.rst b/Doc/library/rfc822.rst
index 52df013..da9f536 100644
--- a/Doc/library/rfc822.rst
+++ b/Doc/library/rfc822.rst
@@ -198,10 +198,12 @@ A :class:`Message` instance has the following methods:
.. method:: Message.getheader(name[, default])
- Like ``getrawheader(name)``, but strip leading and trailing whitespace.
+ Return a single string consisting of the last header matching *name*,
+ but strip leading and trailing whitespace.
Internal whitespace is not stripped. The optional *default* argument can be
used to specify a different default to be returned when there is no header
- matching *name*.
+ matching *name*; it defaults to ``None``.
+ This is the preferred way to get parsed headers.
.. method:: Message.get(name[, default])