mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-22 06:32:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Docstring consistency with the updated .tex files.

Browse source
This commit is contained in:
Barry Warsaw 2002-09-30 23:07:35 +00:00
parent 0031982c21
commit 48330687f3
1 changed files with 4 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
Lib/email/Header.py
View file

@ -205,11 +205,12 @@ class Header:
s may be a byte string or a Unicode string. If it is a byte string s may be a byte string or a Unicode string. If it is a byte string
(i.e. isinstance(s, StringType) is true), then charset is the encoding (i.e. isinstance(s, StringType) is true), then charset is the encoding
of that byte string, and a UnicodeError will be raised if the string of that byte string, and a UnicodeError will be raised if the string
cannot be decoded with that charset. If `s' is a Unicode string, then cannot be decoded with that charset. If s is a Unicode string, then
charset is a hint specifying the character set of the characters in charset is a hint specifying the character set of the characters in
the string. In this case, when producing an RFC 2822 compliant header the string. In this case, when producing an RFC 2822 compliant header
using RFC 2047 rules, the Unicode string will be encoded using the using RFC 2047 rules, the Unicode string will be encoded using the
following charsets in order: us-ascii, the charset hint, utf-8. following charsets in order: us-ascii, the charset hint, utf-8. The
first character set not to provoke a UnicodeError is used.
""" """
if charset is None: if charset is None:
charset = self._charset charset = self._charset
@ -376,7 +377,7 @@ class Header:
return joiner.join(chunks) return joiner.join(chunks)
def encode(self): def encode(self):
"""Encode a message header, possibly converting charset and encoding. """Encode a message header into an RFC-compliant format.
There are many issues involved in converting a given string for use in There are many issues involved in converting a given string for use in
an email header. Only certain character sets are readable in most an email header. Only certain character sets are readable in most