diff options
| author | Fabio Sangiovanni <4040184+sanjioh@users.noreply.github.com> | 2019-12-25 23:45:30 +0100 |
|---|---|---|
| committer | Eric V. Smith <ericvsmith@users.noreply.github.com> | 2019-12-25 17:45:30 -0500 |
| commit | e28aff54d95236ea1b64b648d89a1516e446e621 (patch) | |
| tree | e4bda57a88c1e328c1ef31452175e0fb7d668447 /Doc/library/dataclasses.rst | |
| parent | 527f9de6efdcf09983d0764be0b978ddc1fd1653 (diff) | |
| download | cpython-git-e28aff54d95236ea1b64b648d89a1516e446e621.tar.gz | |
bpo-33961: Adjusted dataclasses docs to correct exceptions raised. (GH-7917) (GH-17677)
Diffstat (limited to 'Doc/library/dataclasses.rst')
| -rw-r--r-- | Doc/library/dataclasses.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/dataclasses.rst b/Doc/library/dataclasses.rst index 71768abf80..c125a1130a 100644 --- a/Doc/library/dataclasses.rst +++ b/Doc/library/dataclasses.rst @@ -60,8 +60,9 @@ Module-level decorators, classes, and functions The :func:`dataclass` decorator will add various "dunder" methods to the class, described below. If any of the added methods already - exist on the class, a :exc:`TypeError` will be raised. The decorator - returns the same class that is called on: no new class is created. + exist on the class, the behavior depends on the parameter, as documented + below. The decorator returns the same class that is called on; no new + class is created. If :func:`dataclass` is used just as a simple decorator with no parameters, it acts as if it has the default values documented in this @@ -115,7 +116,7 @@ Module-level decorators, classes, and functions If the class already defines any of :meth:`__lt__`, :meth:`__le__`, :meth:`__gt__`, or :meth:`__ge__`, then - :exc:`ValueError` is raised. + :exc:`TypeError` is raised. - ``unsafe_hash``: If ``False`` (the default), a :meth:`__hash__` method is generated according to how ``eq`` and ``frozen`` are set. |