]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] gh-103886: Improve `builtins.__doc__` (GH-104179) (#104257)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 7 May 2023 02:28:04 +0000 (19:28 -0700)
committerGitHub <noreply@github.com>
Sun, 7 May 2023 02:28:04 +0000 (02:28 +0000)
gh-103886: Improve `builtins.__doc__` (GH-104179)
(cherry picked from commit b35711d17a90251bdd57d255090e07daafe89f6c)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Python/bltinmodule.c

index 6c8725f98231133ac0687994dbc371ff704e208c..e20bd5396bf562a67df1936fc509ccdfcca9dd38 100644 (file)
@@ -2999,9 +2999,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.len is\n\
+the full name for the built-in function len().\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,