classification
Title: Inconsistency in exceptions for dataclasses.dataclass documentation
Type: Stage: resolved
Components: Documentation Versions: Python 3.8, Python 3.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: chriscog, docs@python, eric.smith
Priority: normal Keywords: patch

Created on 2018-06-25 21:54 by chriscog, last changed 2019-02-22 07:54 by inada.naoki. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 7917 merged python-dev, 2018-06-25 22:49
Messages (4)
msg320444 - (view) Author: Chris Cogdon (chriscog) * Date: 2018-06-25 21:54
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.
msg320451 - (view) Author: Chris Cogdon (chriscog) * Date: 2018-06-25 22:54
Also, one occurrence of s/:/;/

This is my First PR! I've read the contribution docs, but am very open to correction.
msg320452 - (view) Author: Chris Cogdon (chriscog) * Date: 2018-06-25 22:55
CLA signed.
msg320867 - (view) Author: Eric V. Smith (eric.smith) * (Python committer) Date: 2018-07-02 10:22
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/24d74bd8377d38528566437e70fcd72229695ac7
History
Date User Action Args
2019-02-22 07:54:16inada.naokisetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2018-07-02 10:22:01eric.smithsetmessages: + msg320867
2018-06-25 22:55:38chriscogsetmessages: + msg320452
2018-06-25 22:54:10chriscogsetmessages: + msg320451
2018-06-25 22:49:42python-devsetkeywords: + patch
stage: patch review
pull_requests: + pull_request7521
2018-06-25 22:11:29eric.smithsetnosy: + eric.smith

versions: + Python 3.8
2018-06-25 21:54:55chriscogcreate