This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: Fix/update missing parameters in function signatures for Built-in Functions documentation.
Type: behavior Stage: patch review
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: AlexWaygood, docs@python, rhettinger, vivekvashist
Priority: normal Keywords: patch

Created on 2021-12-15 23:27 by vivekvashist, last changed 2022-04-11 14:59 by admin.

Pull Requests
URL Status Linked Edit
PR 30128 open vivekvashist, 2021-12-15 23:28
Messages (5)
msg408653 - (view) Author: Vivek Vashist (vivekvashist) * Date: 2021-12-15 23:27
Previous issue:

As noted/pointed by Alex - I went through all the Built-in Functions and updated/fixed the missing parameters.

I'll raise a PR shortly.
msg408655 - (view) Author: Vivek Vashist (vivekvashist) * Date: 2021-12-15 23:29
msg408676 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2021-12-16 07:14
My understanding is that we're holding off on adding the slash notation to the main docs.  The reason is that they are mostly unintelligible to the average user.
msg408678 - (view) Author: Alex Waygood (AlexWaygood) * (Python triager) Date: 2021-12-16 09:23
It concerns me that help() gives very different results for some of these functions than the signature you'll find in the documentation. I think a beginner would find that highly confusing. If the view is that the slash notation should not be added to this piece of documentation, since it is aimed at beginners, should help() be changed so that it does not include the slash notation for built-in functions?
msg408817 - (view) Author: Vivek Vashist (vivekvashist) * Date: 2021-12-17 21:20
Noticed that new removeprefix() and removesuffix() functions that were added in 3.9 have slash notation added in Built-in Types document.

str.removeprefix(prefix, /)
str.removesuffix(suffix, /)
Date User Action Args
2022-04-11 14:59:53adminsetgithub: 90250
2021-12-17 21:20:50vivekvashistsetmessages: + msg408817
2021-12-16 09:23:16AlexWaygoodsetmessages: + msg408678
2021-12-16 07:14:55rhettingersetnosy: + rhettinger
messages: + msg408676
2021-12-16 00:12:13AlexWaygoodsetnosy: + AlexWaygood

versions: + Python 3.9, Python 3.11
2021-12-15 23:29:20vivekvashistsetmessages: + msg408655
2021-12-15 23:28:12vivekvashistsetkeywords: + patch
stage: patch review
pull_requests: + pull_request28347
2021-12-15 23:27:12vivekvashistcreate