Christopher Barker <Chris.Barker@noaa.gov> added the comment: It was suggested that I could contirbute to the docs of dataclasses in this issue. Which confuses me, as there doesn't appear to be any content here to comment on. But what the heck: As I've been annoyingly persistent about on the python-dev list, I think we need to be quite careful about making type hints appear to be a requirement for using dataclasses. In order to counter this, we could: * have the first couple example be type-less: @dataclass class C: a: ... # field without a default b: ... = 0 # field with a default or something like that. Then purposely introduce "how to add type hints" a bit down in the docs. ---------- nosy: +Chris.Barker _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________

STINNER Victor <victor.stinner@gmail.com> added the comment: My Issue32406 has been marked as a duplicate of this one. Copy of my message: bpo-32214 "Implement PEP 557: Data Classes" added a new dataclasses module and was closed, but the new module is not documented: https://docs.python.org/dev/library/dataclasses.html And it's also missing from What's New in Python 3.7: https://docs.python.org/dev/whatsnew/3.7.html ---------- nosy: +vstinner _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________

Eric V. Smith <eric@trueblade.com> added the comment: I was hoping a volunteer would step up to write the documentation, as it's definitely not my forte. Raymond has also volunteered to help. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________

Mariatta Wijaya <mariatta.wijaya@gmail.com> added the comment: I'd be interested to help write the PR for this. ---------- nosy: +Mariatta _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________

Christopher Barker <Chris.Barker@noaa.gov> added the comment: Thanks Raymond. Can a draft be put in a gitHub repo so we can all help out? ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________

Lino Mastrodomenico <l.mastrodomenico@gmail.com> added the comment: Friendly ping, there's still no documentation for this wonderful new module and there's only one planned beta left for 3.7 before the release candidates. Needless to say, https://www.python.org/dev/peps/pep-0557/ has lots of information that could be a starting point. ---------- nosy: +mastrodomenico _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________

Eric V. Smith <eric@trueblade.com> added the comment: Note that the documentation should make the implications of #33453 very clear. In short, if an annotation "looks like" a ClassVar or InitVar, it will be treated as such. This is true even if it's specified as a string, or if it's a string due to "from __future__ import annotations". I'm planning on specifying more details in #33453. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________

Change by Eric V. Smith <eric@trueblade.com>: ---------- keywords: +patch pull_requests: +6560 stage: needs patch -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________

Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +6566 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________

Eric V. Smith <eric@trueblade.com> added the comment: I've added some initial documentation. Most of it is text from the PEP, cleaned up and sphinx-ized. It no doubt needs a lot of work, but I think it's good enough to close this issue and remove the release blocker. Changes to the documentation can be done going forward, including after 3.7.0rc1 is released. ---------- assignee: docs@python -> eric.smith priority: release blocker -> resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________

Barry A. Warsaw <barry@python.org> added the comment: ...although I unfortunately cannot build it because of Issue33543 ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________

Barry A. Warsaw <barry@python.org> added the comment: New changeset 713a9367366c88662c39ed20dd6bce22399299f1 by Barry Warsaw in branch 'master': bpo-32216: Update dataclasses documentation (#6913) https://github.com/python/cpython/commit/713a9367366c88662c39ed20dd6bce22399... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________

Change by Barry A. Warsaw <barry@python.org>: ---------- stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue32216> _______________________________________