traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Issue #18326: merge with 3.3

This commit is contained in:
Zachary Ware 2013-11-22 14:03:10 -06:00
parent 58ca93cb69 e1391a0d68
commit e19e3f0b91
3 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Doc/glossary.rst
View File

@ -41,7 +41,7 @@ Glossary
argument argument
A value passed to a :term:`function` (or :term:`method`) when calling the A value passed to a :term:`function` (or :term:`method`) when calling the
function. There are two types of arguments: function. There are two kinds of argument:
* :dfn:`keyword argument`: an argument preceded by an identifier (e.g. * :dfn:`keyword argument`: an argument preceded by an identifier (e.g.
``name=``) in a function call or passed as a value in a dictionary ``name=``) in a function call or passed as a value in a dictionary
@ -601,7 +601,7 @@ Glossary
parameter parameter
A named entity in a :term:`function` (or method) definition that A named entity in a :term:`function` (or method) definition that
specifies an :term:`argument` (or in some cases, arguments) that the specifies an :term:`argument` (or in some cases, arguments) that the
function can accept. There are five types of parameters: function can accept. There are five kinds of parameter:
* :dfn:`positional-or-keyword`: specifies an argument that can be passed * :dfn:`positional-or-keyword`: specifies an argument that can be passed
either :term:`positionally <argument>` or as a :term:`keyword argument either :term:`positionally <argument>` or as a :term:`keyword argument
@ -615,6 +615,8 @@ Glossary
parameters. However, some built-in functions have positional-only parameters. However, some built-in functions have positional-only
parameters (e.g. :func:`abs`). parameters (e.g. :func:`abs`).
.. _keyword-only_parameter:
* :dfn:`keyword-only`: specifies an argument that can be supplied only * :dfn:`keyword-only`: specifies an argument that can be supplied only
by keyword. Keyword-only parameters can be defined by including a by keyword. Keyword-only parameters can be defined by including a
single var-positional parameter or bare ``*`` in the parameter list single var-positional parameter or bare ``*`` in the parameter list

3
Doc/library/stdtypes.rst
View File

@ -1149,6 +1149,9 @@ application).
fail, the entire sort operation will fail (and the list will likely be left fail, the entire sort operation will fail (and the list will likely be left
in a partially modified state). in a partially modified state).
:meth:`sort` accepts two arguments that can only be passed by keyword
(:ref:`keyword-only arguments <keyword-only_parameter>`):
*key* specifies a function of one argument that is used to extract a *key* specifies a function of one argument that is used to extract a
comparison key from each list element (for example, ``key=str.lower``). comparison key from each list element (for example, ``key=str.lower``).
The key corresponding to each item in the list is calculated once and The key corresponding to each item in the list is calculated once and

7
Misc/NEWS
View File

@ -351,6 +351,13 @@ Tests
- Issue 19384: Fix test_py_compile for root user, patch by Claudiu Popa. - Issue 19384: Fix test_py_compile for root user, patch by Claudiu Popa.
Documentation
-------------
- Issue #18326: Clarify that list.sort's arguments are keyword-only. Also,
attempt to reduce confusion in the glossary by not saying there are
different "types" of arguments and parameters.
Build Build
----- -----