summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorБорис Верховский <boris.verk@gmail.com>2021-01-22 00:47:23 -0500
committerGitHub <noreply@github.com>2021-01-22 00:47:23 -0500
commit644d52818a6391535e5838fd57d58ffcb1163056 (patch)
tree724a0887b76f8925be82f5c1f87526ccfbbfd180
parentbpo-42384: pdb: correctly populate sys.path[0] (GH-23338) (diff)
downloadcpython-644d52818a6391535e5838fd57d58ffcb1163056.tar.gz
cpython-644d52818a6391535e5838fd57d58ffcb1163056.tar.bz2
cpython-644d52818a6391535e5838fd57d58ffcb1163056.zip
bpo-40304: Correct type(name, bases, dict) doc (GH-19553)
Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu> Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>
-rw-r--r--Doc/library/functions.rst17
-rw-r--r--Misc/NEWS.d/next/Documentation/2021-01-20-23-03-49.bpo-40304.-LK7Ps.rst2
2 files changed, 11 insertions, 8 deletions
diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index 0598a6ce941..f28d63b6b3d 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -1703,18 +1703,19 @@ are always available. They are listed here in alphabetical order.
With three arguments, return a new type object. This is essentially a
- dynamic form of the :keyword:`class` statement. The *name* string is the
- class name and becomes the :attr:`~definition.__name__` attribute; the *bases*
- tuple itemizes the base classes and becomes the :attr:`~class.__bases__`
- attribute; and the *dict* dictionary is the namespace containing definitions
- for class body and is copied to a standard dictionary to become the
- :attr:`~object.__dict__` attribute. For example, the following two
- statements create identical :class:`type` objects:
+ dynamic form of the :keyword:`class` statement. The *name* string is
+ the class name and becomes the :attr:`~definition.__name__` attribute.
+ The *bases* tuple contains the base classes and becomes the
+ :attr:`~class.__bases__` attribute; if empty, :class:`object`, the
+ ultimate base of all classes, is added. The *dict* dictionary contains
+ attribute and method definitions for the class body; it may be copied
+ or wrapped before becoming the :attr:`~object.__dict__` attribute.
+ The following two statements create identical :class:`type` objects:
>>> class X:
... a = 1
...
- >>> X = type('X', (object,), dict(a=1))
+ >>> X = type('X', (), dict(a=1))
See also :ref:`bltin-type-objects`.
diff --git a/Misc/NEWS.d/next/Documentation/2021-01-20-23-03-49.bpo-40304.-LK7Ps.rst b/Misc/NEWS.d/next/Documentation/2021-01-20-23-03-49.bpo-40304.-LK7Ps.rst
new file mode 100644
index 00000000000..3f2f14c2d7b
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2021-01-20-23-03-49.bpo-40304.-LK7Ps.rst
@@ -0,0 +1,2 @@
+Fix doc for type(name, bases, dict). Patch by Boris Verkhovskiy and
+Éric Araujo.