diff options
author | Saiyang Gou <gousaiyang@163.com> | 2021-04-07 19:32:24 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-04-07 19:32:24 (GMT) |
commit | 4554ab435727a0f3b6441c9c1a8d3fe6534433c7 (patch) | |
tree | a9c4989e06d9f56f88954e546f7d1dfbd0551a6b /Doc | |
parent | 9f578734624d1c0172220556ca97898730144172 (diff) | |
download | cpython-4554ab435727a0f3b6441c9c1a8d3fe6534433c7.zip cpython-4554ab435727a0f3b6441c9c1a8d3fe6534433c7.tar.gz cpython-4554ab435727a0f3b6441c9c1a8d3fe6534433c7.tar.bz2 |
[3.8] bpo-36540: Improve doc of function definition regarding positional-only arguments (GH-25235) (GH-25260)
(cherry picked from commit 58d72cab89cf9652acc0bf0007aa20b2bcc98499)
Co-authored-by: Saiyang Gou <gousaiyang@163.com>
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/reference/compound_stmts.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/Doc/reference/compound_stmts.rst b/Doc/reference/compound_stmts.rst index 61037d9..9dd471a 100644 --- a/Doc/reference/compound_stmts.rst +++ b/Doc/reference/compound_stmts.rst @@ -582,19 +582,25 @@ e.g.:: return penguin .. index:: + single: / (slash); function definition single: * (asterisk); function definition single: **; function definition Function call semantics are described in more detail in section :ref:`calls`. A function call always assigns values to all parameters mentioned in the parameter -list, either from position arguments, from keyword arguments, or from default +list, either from positional arguments, from keyword arguments, or from default values. If the form "``*identifier``" is present, it is initialized to a tuple receiving any excess positional parameters, defaulting to the empty tuple. If the form "``**identifier``" is present, it is initialized to a new ordered mapping receiving any excess keyword arguments, defaulting to a new empty mapping of the same type. Parameters after "``*``" or "``*identifier``" are keyword-only parameters and may only be passed -used keyword arguments. +by keyword arguments. Parameters before "``/``" are positional-only parameters +and may only be passed by positional arguments. + +.. versionchanged:: 3.8 + The ``/`` function parameter syntax may be used to indicate positional-only + parameters. See :pep:`570` for details. .. index:: pair: function; annotations |