]> granicus.if.org Git - python/commitdiff
Add additional links and index entries for "argument" and "parameter".
authorChris Jerdonek <chris.jerdonek@gmail.com>
Tue, 25 Dec 2012 22:54:44 +0000 (14:54 -0800)
committerChris Jerdonek <chris.jerdonek@gmail.com>
Tue, 25 Dec 2012 22:54:44 +0000 (14:54 -0800)
This adds to the work done for issue #15990 (i.e. f44b8d69e5fc and the
commits referenced there).

Doc/faq/programming.rst
Doc/glossary.rst
Doc/reference/compound_stmts.rst
Doc/reference/expressions.rst

index 2d5d2b123a1130de0884fb9d3b35aeb7580afc6b..aac8e8165280d2f00e719f2b4fa93fc31ecddbb5 100644 (file)
@@ -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?
index ddecc0906bf201db704db43d19cbefd243879ab0..164c01720850e2086b778cabca968a1cbd59d899 100644 (file)
@@ -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
index 688917691f7b58030043d7542adbcca3ce4c94b2..d0d0646b707729ff0fe96530cc897309643f8861 100644 (file)
@@ -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.
index 4b62dceab5d224dacab47f12c26977bf5f66f575..68de3c85cde3410bf4ca81aa5d9a5426d459cc87 100644 (file)
@@ -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