summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJulien Palard <julien@palard.fr>2018-01-30 03:36:06 (GMT)
committerMariatta <Mariatta@users.noreply.github.com>2018-01-30 03:36:06 (GMT)
commit9424dcbb3e20a26dfdd81659303b989f7d3da044 (patch)
tree5d8b43ccef27e4597b5eb5b838a5830a3f156634
parent77526f05fa788d6fb12f2121fe6b96c130d9b717 (diff)
downloadcpython-9424dcbb3e20a26dfdd81659303b989f7d3da044.zip
cpython-9424dcbb3e20a26dfdd81659303b989f7d3da044.tar.gz
cpython-9424dcbb3e20a26dfdd81659303b989f7d3da044.tar.bz2
bpo-32701: Clarify the quotetabs flag in quopri documentation (GH-5401)
-rw-r--r--Doc/library/quopri.rst7
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/quopri.rst b/Doc/library/quopri.rst
index a3f94a0..86717c0 100644
--- a/Doc/library/quopri.rst
+++ b/Doc/library/quopri.rst
@@ -34,9 +34,10 @@ sending a graphics file.
Encode the contents of the *input* file and write the resulting quoted-printable
data to the *output* file. *input* and *output* must be
- :term:`binary file objects <file object>`. *quotetabs*, a flag which controls
- whether to encode embedded spaces and tabs must be provideda and when true it
- encodes such embedded whitespace, and when false it leaves them unencoded.
+ :term:`binary file objects <file object>`. *quotetabs*, a
+ non-optional flag which controls whether to encode embedded spaces
+ and tabs; when true it encodes such embedded whitespace, and when
+ false it leaves them unencoded.
Note that spaces and tabs appearing at the end of lines are always encoded,
as per :rfc:`1521`. *header* is a flag which controls if spaces are encoded
as underscores as per :rfc:`1522`.