Update function signatures to use * and / as needed #131885
Description
Documentation
Caution
For new contributors, please do not consider this issue as an "easy" one. While the changes may seem mechanical, they are not necessarily trivial as this requires to know what really happens (both at a Python and a C level).
This is tracks cases where changes need to be made to enact the Editorial Board's decision for function signature markup.
- builtins:
-
min() -
max() -
range() -
map()
-
- methods on builtins:
-
dict.get(),dict.setdefault()
-
See also:
- https://discuss.python.org/t/editorial-board-decisions/58580
- gh-129667: Update annotation in documentation #129669 (comment)
- https://discuss.python.org/t/81003
- https://devguide.python.org/documentation/style-guide/#function-signatures
- https://discuss.python.org/t/58750
Linked PRs
- gh-131885: Updates docs to make max and min iterable param positional only #131868
- gh-131885: simplify function signatures in the cmath module #131886
- gh-131885: Document that dict.setdefault takes no keyword arguments #128208
- [3.13] gh-131885: Document that
dict.setdefaultanddict.gettake no keyword arguments (GH-128208) #131893 - [3.12] gh-131885: Document that
dict.setdefaultanddict.gettake no keyword arguments (GH-128208) #131894 - gh-131885: Document
/fordecimal.Contextmethods #131990 - gh-131885: Document
/forcodecsfunctions #131992 - gh-131885: Document
*forcode.InteractiveConsole#132029 - gh-131885: update documented signatures for
csv.{writer,reader}#136085 - [3.14] gh-131885: Update documented signatures for
csv.{writer,reader}(GH-136085) #136120 - [3.13] gh-131885: Update documented signatures for
csv.{writer,reader}(GH-136085) #136121