Skip to content

Add separate docstring for frozendict #156986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
corona10 merged 1 commit into from
Sep 6, 2026
+12 −1
Merged

Add separate docstring for frozendict #156986

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion Objects/dictobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8571,6 +8571,17 @@ frozendict_copy_impl(PyFrozenDictObject *self)
return copy;
}

PyDoc_STRVAR(frozendict_doc,
"frozendict() -> new empty immutable dictionary\n"
"frozendict(mapping) -> new immutable dictionary initialized from a mapping\n"
" object's (key, value) pairs\n"
"frozendict(iterable) -> new immutable dictionary initialized as if via:\n"
" d = {}\n"
" for k, v in iterable:\n"
" d[k] = v\n"
" d = frozendict(d)\n"
"frozendict(**kwargs) -> new immutable dictionary initialized with the name=value\n"
" pairs in the keyword argument list. For example: frozendict(one=1, two=2)");

PyTypeObject PyFrozenDict_Type = {
PyVarObject_HEAD_INIT(&PyType_Type, 0)
Expand All @@ -8586,7 +8597,7 @@ PyTypeObject PyFrozenDict_Type = {
.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC
| Py_TPFLAGS_BASETYPE
| _Py_TPFLAGS_MATCH_SELF | Py_TPFLAGS_MAPPING,
.tp_doc = dictionary_doc,
.tp_doc = frozendict_doc,
.tp_traverse = dict_traverse,
.tp_clear = dict_tp_clear,
.tp_richcompare = dict_richcompare,
Expand Down
Loading