]> granicus.if.org Git - python/commitdiff
bpo-33961: Adjusted dataclasses docs to correct exceptions raised. (GH-7917)
authorChris Cogdon <chris@cogdon.org>
Mon, 2 Jul 2018 10:21:50 +0000 (03:21 -0700)
committerEric V. Smith <ericvsmith@users.noreply.github.com>
Mon, 2 Jul 2018 10:21:50 +0000 (06:21 -0400)
Doc/library/dataclasses.rst

index b26f6422db917aa030012f9b93e11fc23dae63e3..9835c480d0ea558fa09a2beefc0b58b0e0f57c87 100644 (file)
@@ -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.