[issue33961] Inconsistency in exceptions for dataclasses.dataclass documentation
New submission from Chris Cogdon <chris@cogdon.org>: The documentation for dataclasses.dataclass includes this text: "If any of the added methods already exist on the class, a TypeError will be raised." However, the documentation for various options has ONE case of TypeError, some cases of ValueError and other cases of "does nothing". I'll attempt a fix and create a PR for this. ---------- assignee: docs@python components: Documentation messages: 320444 nosy: chriscog, docs@python priority: normal severity: normal status: open title: Inconsistency in exceptions for dataclasses.dataclass documentation versions: Python 3.7 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
Change by Eric V. Smith <eric@trueblade.com>: ---------- nosy: +eric.smith versions: +Python 3.8 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
Change by Roundup Robot <devnull@psf.upfronthosting.co.za>: ---------- keywords: +patch pull_requests: +7521 stage: -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
Chris Cogdon <chris@cogdon.org> added the comment: Also, one occurrence of s/:/;/ This is my First PR! I've read the contribution docs, but am very open to correction. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
Chris Cogdon <chris@cogdon.org> added the comment: CLA signed. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
Eric V. Smith <eric@trueblade.com> added the comment: New changeset 24d74bd8377d38528566437e70fcd72229695ac7 by Eric V. Smith (Chris Cogdon) in branch '3.7': bpo-33961: Adjusted dataclasses docs to correct exceptions raised. (GH-7917) https://github.com/python/cpython/commit/24d74bd8377d38528566437e70fcd722296... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
Change by Inada Naoki <songofacandy@gmail.com>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
Fabio Sangiovanni <sjh+bugspython@sanjioh.org> added the comment: Hi, I was looking at the dataclasses docs and it seems to me that the PR associated to this issue has been merged into 3.7 only, but should be backported to 3.8 and to master. I will post a comment on the PR itself as well. Thanks, Fabio ---------- nosy: +sanjioh _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
Change by Fabio Sangiovanni <sjh+bugspython@sanjioh.org>: ---------- pull_requests: +17137 pull_request: https://github.com/python/cpython/pull/17677 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
Eric V. Smith <eric@trueblade.com> added the comment: New changeset e28aff54d95236ea1b64b648d89a1516e446e621 by Eric V. Smith (Fabio Sangiovanni) in branch 'master': bpo-33961: Adjusted dataclasses docs to correct exceptions raised. (GH-7917) (GH-17677) https://github.com/python/cpython/commit/e28aff54d95236ea1b64b648d89a1516e44... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +17152 pull_request: https://github.com/python/cpython/pull/17705 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset a5deabd8e43a76bf2d7923342b6c4395c1a5efcd by Miss Islington (bot) in branch '3.8': bpo-33961: Adjusted dataclasses docs to correct exceptions raised. (GH-7917) (GH-17677) https://github.com/python/cpython/commit/a5deabd8e43a76bf2d7923342b6c4395c1a... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
Eric V. Smith <eric@trueblade.com> added the comment: Thanks, all! ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33961> _______________________________________
participants (6)
-
Chris Cogdon -
Eric V. Smith
-
Fabio Sangiovanni
-
Inada Naoki
-
miss-islington
-
Roundup Robot