classification
Title: Typo in quopri documentation
Type: Stage: resolved
Components: Documentation Versions: Python 3.7, Python 3.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Mariatta, docs@python, mdk, orsenthil
Priority: low Keywords: patch

Created on 2018-01-28 23:34 by mdk, last changed 2018-01-30 04:23 by Mariatta. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 5401 merged mdk, 2018-01-28 23:52
PR 5438 merged miss-islington, 2018-01-30 03:36
Messages (5)
msg311033 - (view) Author: Julien Palard (mdk) * (Python committer) Date: 2018-01-28 23:34
Spotted a typo in https://docs.python.org/3/library/quopri.html: "must be provideda"

But I also can't extract the meaning of the sentence:

> 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.

So here's the diff from 99597c4d12e358174275945d97e504c0318a3783:

+ *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.
- *quotetabs* is a flag which controls whether to encode embedded spaces and tabs; when true it encodes such embedded whitespace, and when false it leaves them unencoded.

So the "must be provided" has been added, I propose:

*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.
msg311034 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2018-01-28 23:47
Thanks! I like your proposed change.

Please create the PR.
msg311221 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2018-01-30 03:36
New changeset 9424dcbb3e20a26dfdd81659303b989f7d3da044 by Mariatta (Julien Palard) in branch 'master':
bpo-32701: Clarify the quotetabs flag in quopri documentation (GH-5401)
https://github.com/python/cpython/commit/9424dcbb3e20a26dfdd81659303b989f7d3da044
msg311226 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2018-01-30 04:16
New changeset 04f99ba9d7186278eaf072e9a62c03aa63a8a6bb by Mariatta (Miss Islington (bot)) in branch '3.6':
bpo-32701: Clarify the quotetabs flag in quopri documentation (GH-5401) (GH-5438)
https://github.com/python/cpython/commit/04f99ba9d7186278eaf072e9a62c03aa63a8a6bb
msg311228 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2018-01-30 04:23
Thanks!
History
Date User Action Args
2018-01-30 04:23:14Mariattasetstatus: open -> closed
resolution: fixed
messages: + msg311228

stage: patch review -> resolved
2018-01-30 04:16:23Mariattasetmessages: + msg311226
2018-01-30 03:36:19miss-islingtonsetpull_requests: + pull_request5271
2018-01-30 03:36:09Mariattasetmessages: + msg311221
2018-01-28 23:52:04mdksetkeywords: + patch
stage: patch review
pull_requests: + pull_request5235
2018-01-28 23:47:34Mariattasetnosy: + Mariatta
messages: + msg311034
2018-01-28 23:34:50mdkcreate