Skip to content

gh-103886: Improve builtins.__doc__ #104179

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
merged 6 commits into from
May 7, 2023
+9 −2
Merged

gh-103886: Improve builtins.__doc__ #104179

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
20b595e
Improve builtins.__doc__
tomasr8 May 4, 2023
f9d3f8c
Add news entry
tomasr8 May 4, 2023
d31b718
Update Python/bltinmodule.c
tomasr8 May 5, 2023
87e07bf
Remove backticks
tomasr8 May 5, 2023
7b3f21b
Remove news entry
tomasr8 May 5, 2023
b99da90
Update Python/bltinmodule.c
tomasr8 May 5, 2023
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
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2023-05-04-23-17-22.gh-issue-103886.IS8tXn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve ``builtins.__doc__``
11 changes: 9 additions & 2 deletions Python/bltinmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3014,9 +3014,16 @@ static PyMethodDef builtin_methods[] = {
};

PyDoc_STRVAR(builtin_doc,
"Built-in functions, exceptions, and other objects.\n\
"Built-in functions, types, exceptions, and other objects.\n\
\n\
Noteworthy: None is the `nil' object; Ellipsis represents `...' in slices.");
This module provides direct access to all 'built-in'\n\
identifiers of Python; for example, `builtins.open` is\n\
the full name for the built-in function `open()`.\n\
\n\
This module is not normally accessed explicitly by most\n\
applications, but can be useful in modules that provide\n\
objects with the same name as a built-in value, but in\n\
which the built-in of that name is also needed.");

static struct PyModuleDef builtinsmodule = {
PyModuleDef_HEAD_INIT,
Expand Down