summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorChris Jerdonek <chris.jerdonek@gmail.com>2012-12-25 22:54:44 (GMT)
committerChris Jerdonek <chris.jerdonek@gmail.com>2012-12-25 22:54:44 (GMT)
commitb43099464a72ae36733cb1993771cc2b825df269 (patch)
tree79cb74ac233acf87574576282d30d79cb789f412 /Doc
parent0b64c1415ea46b2ac7464396d5603fe5cb278870 (diff)
downloadcpython-b43099464a72ae36733cb1993771cc2b825df269.zip
cpython-b43099464a72ae36733cb1993771cc2b825df269.tar.gz
cpython-b43099464a72ae36733cb1993771cc2b825df269.tar.bz2
Add additional links and index entries for "argument" and "parameter".
This adds to the work done for issue #15990 (i.e. f44b8d69e5fc and the commits referenced there).
Diffstat (limited to 'Doc')
-rw-r--r--Doc/faq/programming.rst4
-rw-r--r--Doc/glossary.rst5
-rw-r--r--Doc/reference/compound_stmts.rst14
-rw-r--r--Doc/reference/expressions.rst18
4 files changed, 28 insertions, 13 deletions
diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst
index 2d5d2b1..aac8e81 100644
--- a/Doc/faq/programming.rst
+++ b/Doc/faq/programming.rst
@@ -313,6 +313,10 @@ calling another function by using ``*`` and ``**``::
g(x, *args, **kwargs)
+.. index::
+ single: argument; difference from parameter
+ single: parameter; difference from argument
+
.. _faq-argument-vs-parameter:
What is the difference between arguments and parameters?
diff --git a/Doc/glossary.rst b/Doc/glossary.rst
index ddecc09..164c017 100644
--- a/Doc/glossary.rst
+++ b/Doc/glossary.rst
@@ -240,8 +240,9 @@ Glossary
function
A series of statements which returns some value to a caller. It can also
- be passed zero or more arguments which may be used in the execution of
- the body. See also :term:`argument` and :term:`method`.
+ be passed zero or more :term:`arguments <argument>` which may be used in
+ the execution of the body. See also :term:`parameter`, :term:`method`,
+ and the :ref:`function` section.
__future__
A pseudo-module which programmers can use to enable new language features
diff --git a/Doc/reference/compound_stmts.rst b/Doc/reference/compound_stmts.rst
index 6889176..d0d0646 100644
--- a/Doc/reference/compound_stmts.rst
+++ b/Doc/reference/compound_stmts.rst
@@ -417,6 +417,9 @@ is equivalent to ::
statement.
+.. index::
+ single: parameter; function definition
+
.. _function:
.. _def:
@@ -478,11 +481,14 @@ is equivalent to ::
def func(): pass
func = f1(arg)(f2(func))
-.. index:: triple: default; parameter; value
+.. index::
+ triple: default; parameter; value
+ single: argument; function definition
-When one or more parameters have the form *parameter* ``=`` *expression*, the
-function is said to have "default parameter values." For a parameter with a
-default value, the corresponding argument may be omitted from a call, in which
+When one or more :term:`parameters <parameter>` have the form *parameter* ``=``
+*expression*, the function is said to have "default parameter values." For a
+parameter with a default value, the corresponding :term:`argument` may be
+omitted from a call, in which
case the parameter's default value is substituted. If a parameter has a default
value, all following parameters up until the "``*``" must also have a default
value --- this is a syntactic restriction that is not expressed by the grammar.
diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst
index 4b62dce..68de3c8 100644
--- a/Doc/reference/expressions.rst
+++ b/Doc/reference/expressions.rst
@@ -600,17 +600,18 @@ upper bound and stride, respectively, substituting ``None`` for missing
expressions.
+.. index::
+ object: callable
+ single: call
+ single: argument; call semantics
+
.. _calls:
Calls
-----
-.. index:: single: call
-
-.. index:: object: callable
-
-A call calls a callable object (e.g., a function) with a possibly empty series
-of arguments:
+A call calls a callable object (e.g., a :term:`function`) with a possibly empty
+series of :term:`arguments <argument>`:
.. productionlist::
call: `primary` "(" [`argument_list` [","] | `comprehension`] ")"
@@ -628,11 +629,14 @@ of arguments:
A trailing comma may be present after the positional and keyword arguments but
does not affect the semantics.
+.. index::
+ single: parameter; call semantics
+
The primary must evaluate to a callable object (user-defined functions, built-in
functions, methods of built-in objects, class objects, methods of class
instances, and all objects having a :meth:`__call__` method are callable). All
argument expressions are evaluated before the call is attempted. Please refer
-to section :ref:`function` for the syntax of formal parameter lists.
+to section :ref:`function` for the syntax of formal :term:`parameter` lists.
.. XXX update with kwonly args PEP