diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2021-06-22 07:42:41 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-22 07:42:41 -0700 |
| commit | a65df3f9fc9a51f3e8d710492aafe07b13f0be0f (patch) | |
| tree | 33b98d315ecfa883dba9bd324b41bb9d3afa0082 | |
| parent | 8bc26d8c9d092840054f57f9b4620de0d40d8423 (diff) | |
| download | cpython-git-a65df3f9fc9a51f3e8d710492aafe07b13f0be0f.tar.gz | |
bpo-41621: Document defaultdict's default_factory parameter (GH-21945)
It defaults to None and is positional only.
(cherry picked from commit d1ae57027fc39ff60dcfc1b63881400e5ca3ce56)
Co-authored-by: Dennis Sweeney <36520290+sweeneyde@users.noreply.github.com>
| -rw-r--r-- | Doc/library/collections.rst | 4 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2020-08-24-13-35-04.bpo-41621.nqaw9G.rst | 1 | ||||
| -rw-r--r-- | Modules/_collectionsmodule.c | 2 |
3 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/collections.rst b/Doc/library/collections.rst index 4dc1b9fc2e..5189a2e88a 100644 --- a/Doc/library/collections.rst +++ b/Doc/library/collections.rst @@ -685,9 +685,9 @@ stack manipulations such as ``dup``, ``drop``, ``swap``, ``over``, ``pick``, :class:`defaultdict` objects ---------------------------- -.. class:: defaultdict([default_factory[, ...]]) +.. class:: defaultdict(default_factory=None, /, [...]) - Returns a new dictionary-like object. :class:`defaultdict` is a subclass of the + Return a new dictionary-like object. :class:`defaultdict` is a subclass of the built-in :class:`dict` class. It overrides one method and adds one writable instance variable. The remaining functionality is the same as for the :class:`dict` class and is not documented here. diff --git a/Misc/NEWS.d/next/Documentation/2020-08-24-13-35-04.bpo-41621.nqaw9G.rst b/Misc/NEWS.d/next/Documentation/2020-08-24-13-35-04.bpo-41621.nqaw9G.rst new file mode 100644 index 0000000000..bd193d9163 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2020-08-24-13-35-04.bpo-41621.nqaw9G.rst @@ -0,0 +1 @@ +Document that :class:`collections.defaultdict` parameter ``default_factory`` defaults to None and is positional-only. diff --git a/Modules/_collectionsmodule.c b/Modules/_collectionsmodule.c index 7120e4dda0..2e19b83dce 100644 --- a/Modules/_collectionsmodule.c +++ b/Modules/_collectionsmodule.c @@ -2213,7 +2213,7 @@ defdict_init(PyObject *self, PyObject *args, PyObject *kwds) } PyDoc_STRVAR(defdict_doc, -"defaultdict(default_factory[, ...]) --> dict with default factory\n\ +"defaultdict(default_factory=None, /, [...]) --> dict with default factory\n\ \n\ The default factory is called without arguments to produce\n\ a new value when a key is not present, in __getitem__ only.\n\ |