This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Parameter names are inaccurate in dataclasses docs
Type: behavior Stage: resolved
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: taleinat Nosy List: docs@python, eric.smith, taleinat, zsol
Priority: normal Keywords: patch

Created on 2022-01-07 10:36 by zsol, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 30450 merged zsol, 2022-01-07 10:37
PR 30482 merged miss-islington, 2022-01-08 10:56
PR 30483 merged miss-islington, 2022-01-08 10:56
Messages (8)
msg409957 - (view) Author: Zsolt Dollenstein (zsol) * Date: 2022-01-07 10:36
Parameter names for `asdict`, `astuple`, `is_dataclass`, and `replace` are incorrect in the docs. The first parameter for all these is `obj`.
msg410089 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2022-01-08 10:13
Indeed, the argument name in the code is "obj", and in 3 of those 4 functions it is a normal (positional or keyword) argument, so the name is important.
msg410094 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2022-01-08 10:56
New changeset ef5376e69e72fa922d7f1b3df47b99d3576f9df1 by Zsolt Dollenstein in branch 'main':
bpo-46290: Fix parameter names in dataclasses docs (GH-30450)
https://github.com/python/cpython/commit/ef5376e69e72fa922d7f1b3df47b99d3576f9df1
msg410099 - (view) Author: miss-islington (miss-islington) Date: 2022-01-08 15:09
New changeset 8bef658668bac923166ae160c79720aed5f3b712 by Miss Islington (bot) in branch '3.10':
bpo-46290: Fix parameter names in dataclasses docs (GH-30450)
https://github.com/python/cpython/commit/8bef658668bac923166ae160c79720aed5f3b712
msg410100 - (view) Author: miss-islington (miss-islington) Date: 2022-01-08 15:10
New changeset cd95033d9c27d6c541dfd774b4c5eab4a70a23ab by Miss Islington (bot) in branch '3.9':
bpo-46290: Fix parameter names in dataclasses docs (GH-30450)
https://github.com/python/cpython/commit/cd95033d9c27d6c541dfd774b4c5eab4a70a23ab
msg410101 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2022-01-08 15:14
Thanks for the report and the PR, Zsolt!
msg410102 - (view) Author: Eric V. Smith (eric.smith) * (Python committer) Date: 2022-01-08 18:13
Thanks for committing this, @taleinat. But next time, if it's assigned to me, I'd like to review it first. Thanks!
msg410103 - (view) Author: Tal Einat (taleinat) * (Python committer) Date: 2022-01-08 18:23
Good to know Eric, will do!
History
Date User Action Args
2022-04-11 14:59:54adminsetgithub: 90448
2022-01-08 18:23:29taleinatsetmessages: + msg410103
2022-01-08 18:13:52eric.smithsetmessages: + msg410102
2022-01-08 15:14:33taleinatsetstatus: open -> closed

nosy: - miss-islington
messages: + msg410101

resolution: fixed
stage: patch review -> resolved
2022-01-08 15:10:01miss-islingtonsetmessages: + msg410100
2022-01-08 15:09:45miss-islingtonsetmessages: + msg410099
2022-01-08 10:56:49miss-islingtonsetpull_requests: + pull_request28687
2022-01-08 10:56:44miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request28686
2022-01-08 10:56:41taleinatsetmessages: + msg410094
2022-01-08 10:13:31taleinatsetassignee: eric.smith -> taleinat

messages: + msg410089
nosy: + taleinat
2022-01-07 15:00:03eric.smithsetassignee: docs@python -> eric.smith
2022-01-07 11:00:37AlexWaygoodsetnosy: + eric.smith
type: behavior
2022-01-07 10:37:34zsolsetkeywords: + patch
stage: patch review
pull_requests: + pull_request28655
2022-01-07 10:36:09zsolcreate