Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace TypeError with ValueError in doc regarding "embedded NUL character" #71668

Closed
zhangyangyu opened this issue Jul 11, 2016 · 8 comments
Closed
Assignees
Labels
docs Documentation in the Doc dir

Comments

@zhangyangyu
Copy link
Member

BPO 27481
Nosy @serhiy-storchaka, @zhangyangyu
Files
  • null_characters_doc.patch
  • null_characters_doc_v2.patch: add versionchanged tag
  • null_characters_doc_v3.patch: change NUL bytes/characters to null bytes/characters
  • null_characters_doc_v4.patch
  • Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = 'https://github.com/serhiy-storchaka'
    closed_at = <Date 2016-07-12.06:16:14.040>
    created_at = <Date 2016-07-11.08:55:36.381>
    labels = ['docs']
    title = 'Replace TypeError with ValueError in doc regarding "embedded NUL character"'
    updated_at = <Date 2016-07-12.06:16:14.039>
    user = 'https://github.com/zhangyangyu'

    bugs.python.org fields:

    activity = <Date 2016-07-12.06:16:14.039>
    actor = 'serhiy.storchaka'
    assignee = 'serhiy.storchaka'
    closed = True
    closed_date = <Date 2016-07-12.06:16:14.040>
    closer = 'serhiy.storchaka'
    components = ['Documentation']
    creation = <Date 2016-07-11.08:55:36.381>
    creator = 'xiang.zhang'
    dependencies = []
    files = ['43685', '43686', '43689', '43690']
    hgrepos = []
    issue_num = 27481
    keywords = ['patch']
    message_count = 8.0
    messages = ['270164', '270166', '270170', '270172', '270173', '270174', '270229', '270230']
    nosy_count = 4.0
    nosy_names = ['docs@python', 'python-dev', 'serhiy.storchaka', 'xiang.zhang']
    pr_nums = []
    priority = 'normal'
    resolution = 'fixed'
    stage = 'resolved'
    status = 'closed'
    superseder = None
    type = None
    url = 'https://bugs.python.org/issue27481'
    versions = ['Python 3.5', 'Python 3.6']

    @zhangyangyu
    Copy link
    Member Author

    Errors regarding "embedded NUL character" were changed from TypeError to ValueError, in r92365, bpo-22215, but the doc doesn't get updated. Add a patch to apply the change in doc.

    @zhangyangyu zhangyangyu added the docs Documentation in the Doc dir label Jul 11, 2016
    @zhangyangyu
    Copy link
    Member Author

    Just for a note, there has already been an bpo-26401 fixing the function.rst. Upload a new patch adding versionchanged tag.

    @serhiy-storchaka
    Copy link
    Member

    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.

    @zhangyangyu
    Copy link
    Member Author

    Yes. I noticed the change but didn't change it. Now add it.

    @serhiy-storchaka
    Copy link
    Member

    Python strings contain characters, not bytes.

    @zhangyangyu
    Copy link
    Member Author

    Sorry, I didn't notice the difference.

    @serhiy-storchaka
    Copy link
    Member

    LGTM. Thanks Xiang.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Jul 12, 2016

    New changeset 420030a5e854 by Serhiy Storchaka in branch '3.5':
    Issue bpo-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 bpo-27481: Docummented that ValueError is now raised instead of TypeError
    https://hg.python.org/cpython/rev/00b9c734af87

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    docs Documentation in the Doc dir
    Projects
    None yet
    Development

    No branches or pull requests

    2 participants