[Python-checkins] Fix reST markup in dataclasses.rst (GH-27843) (GH-27845)

ericvsmith webhook-mailer at python.org
Thu Aug 19 16:49:19 EDT 2021


https://github.com/python/cpython/commit/f0e2a46349bc5a733aee58d53fa685de108b1787
commit: f0e2a46349bc5a733aee58d53fa685de108b1787
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: ericvsmith <ericvsmith at users.noreply.github.com>
date: 2021-08-19T16:49:15-04:00
summary:

Fix reST markup in dataclasses.rst (GH-27843) (GH-27845)

The signature of field() had an extraneous colon at the end, causing it
to appear all bold and without the module name.
(cherry picked from commit d26dbba9297adb59bc49a6583c647804ef56fc58)

Co-authored-by: Jean-Abou-Samra <37271310+Jean-Abou-Samra at users.noreply.github.com>

Co-authored-by: Jean-Abou-Samra <37271310+Jean-Abou-Samra at users.noreply.github.com>

files:
M Doc/library/dataclasses.rst

diff --git a/Doc/library/dataclasses.rst b/Doc/library/dataclasses.rst
index e203a1a2132df..5da05539c90b1 100644
--- a/Doc/library/dataclasses.rst
+++ b/Doc/library/dataclasses.rst
@@ -205,7 +205,7 @@ Module contents
    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, init=True, repr=True, hash=None, compare=True, metadata=None, kw_only=MISSING):
+.. function:: field(*, default=MISSING, default_factory=MISSING, init=True, repr=True, hash=None, compare=True, metadata=None, kw_only=MISSING)
 
    For common and simple use cases, no other functionality is
    required.  There are, however, some dataclass features that



More information about the Python-checkins mailing list