[Python-checkins] Fix minor grammar problems in dataclasses documentation (GH-25948) (#25959)

ericvsmith webhook-mailer at python.org
Thu May 6 17:55:03 EDT 2021


https://github.com/python/cpython/commit/7424105a02bbc209e032752636bae30ccb556402
commit: 7424105a02bbc209e032752636bae30ccb556402
branch: 3.9
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: ericvsmith <ericvsmith at users.noreply.github.com>
date: 2021-05-06T17:54:58-04:00
summary:

Fix minor grammar problems in dataclasses documentation (GH-25948) (#25959)

Some missing words; some odd word choices.
(cherry picked from commit ee8e7c2fa950f88ba2c33035bea7aed7aaf0cb77)

Co-authored-by: Scott Noyes <snoyes at gmail.com>

Co-authored-by: Scott Noyes <snoyes at gmail.com>

files:
M Doc/library/dataclasses.rst

diff --git a/Doc/library/dataclasses.rst b/Doc/library/dataclasses.rst
index 8711191500c60..de5a8e1200ff3 100644
--- a/Doc/library/dataclasses.rst
+++ b/Doc/library/dataclasses.rst
@@ -17,7 +17,7 @@ adding generated :term:`special method`\s such as :meth:`__init__` and
 in :pep:`557`.
 
 The member variables to use in these generated methods are defined
-using :pep:`526` type annotations.  For example this code::
+using :pep:`526` type annotations.  For example, this code::
 
   from dataclasses import dataclass
 
@@ -31,7 +31,7 @@ using :pep:`526` type annotations.  For example this code::
       def total_cost(self) -> float:
           return self.unit_price * self.quantity_on_hand
 
-Will add, among other things, a :meth:`__init__` that looks like::
+will add, among other things, a :meth:`__init__` that looks like::
 
   def __init__(self, name: str, unit_price: float, quantity_on_hand: int = 0):
       self.name = name
@@ -52,7 +52,7 @@ Module-level decorators, classes, and functions
    :term:`special method`\s to classes, as described below.
 
    The :func:`dataclass` decorator examines the class to find
-   ``field``\s.  A ``field`` is defined as class variable that has a
+   ``field``\s.  A ``field`` is defined as a class variable that has a
    :term:`type annotation <variable annotation>`.  With two
    exceptions described below, nothing in :func:`dataclass`
    examines the type specified in the variable annotation.
@@ -62,8 +62,8 @@ 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, the behavior depends on the parameter, as documented
-   below. The decorator returns the same class that is called on; no new
+   exist in the class, the behavior depends on the parameter, as documented
+   below. The decorator returns the same class that it is called on; no new
    class is created.
 
    If :func:`dataclass` is used just as a simple decorator with no parameters,
@@ -175,7 +175,7 @@ Module-level decorators, classes, and functions
      def __init__(self, a: int, b: int = 0):
 
    :exc:`TypeError` will be raised if a field without a default value
-   follows a field with a default value.  This is true either when this
+   follows a field with a default value.  This is true whether this
    occurs in a single class, or as a result of class inheritance.
 
 .. function:: field(*, default=MISSING, default_factory=MISSING, repr=True, hash=None, init=True, compare=True, metadata=None)
@@ -361,7 +361,7 @@ Module-level decorators, classes, and functions
 
 .. function:: replace(instance, /, **changes)
 
-   Creates a new object of the same type of ``instance``, replacing
+   Creates a new object of the same type as ``instance``, replacing
    fields with values from ``changes``.  If ``instance`` is not a Data
    Class, raises :exc:`TypeError`.  If values in ``changes`` do not
    specify fields, raises :exc:`TypeError`.



More information about the Python-checkins mailing list