classification
Title: Replace TypeError with ValueError in doc regarding "embedded NUL character"
Type: Stage: resolved
Components: Documentation Versions: Python 3.6, Python 3.5
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: serhiy.storchaka Nosy List: docs@python, python-dev, serhiy.storchaka, xiang.zhang
Priority: normal Keywords: patch

Created on 2016-07-11 08:55 by xiang.zhang, last changed 2016-07-12 06:16 by serhiy.storchaka. This issue is now closed.

Files
File name Uploaded Description Edit
null_characters_doc.patch xiang.zhang, 2016-07-11 08:55 review
null_characters_doc_v2.patch xiang.zhang, 2016-07-11 09:18 add versionchanged tag review
null_characters_doc_v3.patch xiang.zhang, 2016-07-11 10:08 change NUL bytes/characters to null bytes/characters review
null_characters_doc_v4.patch xiang.zhang, 2016-07-11 10:18 review
Messages (8)
msg270164 - (view) Author: Xiang Zhang (xiang.zhang) * (Python committer) Date: 2016-07-11 08:55
Errors regarding "embedded NUL character" were changed from TypeError to ValueError, in r92365, issue22215, but the doc doesn't get updated. Add a patch to apply the change in doc.
msg270166 - (view) Author: Xiang Zhang (xiang.zhang) * (Python committer) Date: 2016-07-11 09:18
Just for a note, there has already been an issue26401 fixing the function.rst. Upload a new patch adding versionchanged tag.
msg270170 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2016-07-11 09:57
LGTM.

But while we are here, it would be worth to change "NUL character" and "NUL byte" to "null character" or "null byte" as most used in the documentation and the code.
msg270172 - (view) Author: Xiang Zhang (xiang.zhang) * (Python committer) Date: 2016-07-11 10:08
Yes. I noticed the change but didn't change it. Now add it.
msg270173 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2016-07-11 10:12
Python strings contain characters, not bytes.
msg270174 - (view) Author: Xiang Zhang (xiang.zhang) * (Python committer) Date: 2016-07-11 10:18
Sorry, I didn't notice the difference.
msg270229 - (view) Author: Serhiy Storchaka (serhiy.storchaka) * (Python committer) Date: 2016-07-12 06:11
LGTM. Thanks Xiang.
msg270230 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-07-12 06:15
New changeset 420030a5e854 by Serhiy Storchaka in branch '3.5':
Issue #27481: Docummented that ValueError is now raised instead of TypeError
https://hg.python.org/cpython/rev/420030a5e854

New changeset 00b9c734af87 by Serhiy Storchaka in branch 'default':
Issue #27481: Docummented that ValueError is now raised instead of TypeError
https://hg.python.org/cpython/rev/00b9c734af87
History
Date User Action Args
2016-07-12 06:16:14serhiy.storchakasetstatus: open -> closed
resolution: fixed
stage: commit review -> resolved
2016-07-12 06:15:33python-devsetnosy: + python-dev
messages: + msg270230
2016-07-12 06:11:31serhiy.storchakasetmessages: + msg270229
2016-07-11 10:18:25xiang.zhangsetfiles: + null_characters_doc_v4.patch

messages: + msg270174
2016-07-11 10:12:41serhiy.storchakasetmessages: + msg270173
2016-07-11 10:08:48xiang.zhangsetfiles: + null_characters_doc_v3.patch

messages: + msg270172
2016-07-11 09:57:19serhiy.storchakasetassignee: docs@python -> serhiy.storchaka
stage: commit review
messages: + msg270170
versions: + Python 3.5
2016-07-11 09:18:05xiang.zhangsetfiles: + null_characters_doc_v2.patch

messages: + msg270166
2016-07-11 08:55:36xiang.zhangcreate