summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Jerdonek <chris.jerdonek@gmail.com>2012-12-25 22:50:21 (GMT)
committerChris Jerdonek <chris.jerdonek@gmail.com>2012-12-25 22:50:21 (GMT)
commitcf4710c3234f77d68e57bf8fe2d9ca4e96a8b085 (patch)
treed79c8229e6425eb3fc79d299ca8c32fce2d8d2e1
parentb0d1c37d737742eb098b985475987f460a13a6c2 (diff)
downloadcpython-cf4710c3234f77d68e57bf8fe2d9ca4e96a8b085.zip
cpython-cf4710c3234f77d68e57bf8fe2d9ca4e96a8b085.tar.gz
cpython-cf4710c3234f77d68e57bf8fe2d9ca4e96a8b085.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).
-rw-r--r--Doc/faq/programming.rst4
-rw-r--r--Doc/glossary.rst5
-rw-r--r--Doc/reference/compound_stmts.rst18
-rw-r--r--Doc/reference/expressions.rst18
4 files changed, 30 insertions, 15 deletions
diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst
index 8e218c0..edee68a 100644
--- a/Doc/faq/programming.rst
+++ b/Doc/faq/programming.rst
@@ -469,6 +469,10 @@ In the unlikely case that you care about Python versions older than 2.0, use
apply(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 e742336..392a60c 100644
--- a/Doc/glossary.rst
+++ b/Doc/glossary.rst
@@ -245,8 +245,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 a86eb11..4a616eb 100644
--- a/Doc/reference/compound_stmts.rst
+++ b/Doc/reference/compound_stmts.rst
@@ -407,6 +407,9 @@ is equivalent to ::
statement.
+.. index::
+ single: parameter; function definition
+
.. _function:
.. _def:
@@ -467,12 +470,15 @@ is equivalent to::
def func(): pass
func = f1(arg)(f2(func))
-.. index:: triple: default; parameter; value
-
-When one or more top-level 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 case the parameter's default value is substituted. If a
+.. index::
+ triple: default; parameter; value
+ single: argument; function definition
+
+When one or more top-level :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 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 e5955bf..812fb70 100644
--- a/Doc/reference/expressions.rst
+++ b/Doc/reference/expressions.rst
@@ -667,17 +667,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` [","]
@@ -696,12 +697,15 @@ 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 certain class instances themselves are callable; extensions may
define additional callable object types). All argument expressions are
evaluated before the call is attempted. Please refer to section :ref:`function`
-for the syntax of formal parameter lists.
+for the syntax of formal :term:`parameter` lists.
If keyword arguments are present, they are first converted to positional
arguments, as follows. First, a list of unfilled slots is created for the