diff options
author | Chris Jerdonek <chris.jerdonek@gmail.com> | 2012-11-28 10:29:33 (GMT) |
---|---|---|
committer | Chris Jerdonek <chris.jerdonek@gmail.com> | 2012-11-28 10:29:33 (GMT) |
commit | c2a7fd60e1e1cc86c52d7409b5b8d84ee447a4ae (patch) | |
tree | 5e49fc55f89280955ea9b798443a869c58e03941 /Doc/faq/programming.rst | |
parent | 14b04cd350acad54e5bc87745c8c55823e2fbecf (diff) | |
download | cpython-c2a7fd60e1e1cc86c52d7409b5b8d84ee447a4ae.zip cpython-c2a7fd60e1e1cc86c52d7409b5b8d84ee447a4ae.tar.gz cpython-c2a7fd60e1e1cc86c52d7409b5b8d84ee447a4ae.tar.bz2 |
Improve argument/parameter documentation (issue #15990).
This commit adds "parameter" to the glossary, improves and consolidates the
"argument" glossary entry, and adds a question to the FAQ on the difference
between arguments and parameters.
Diffstat (limited to 'Doc/faq/programming.rst')
-rw-r--r-- | Doc/faq/programming.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/Doc/faq/programming.rst b/Doc/faq/programming.rst index d33e25b..2d5d2b1 100644 --- a/Doc/faq/programming.rst +++ b/Doc/faq/programming.rst @@ -313,6 +313,27 @@ calling another function by using ``*`` and ``**``:: g(x, *args, **kwargs) +.. _faq-argument-vs-parameter: + +What is the difference between arguments and parameters? +-------------------------------------------------------- + +:term:`Parameters <parameter>` are defined by the names that appear in a +function definition, whereas :term:`arguments <argument>` are the values +actually passed to a function when calling it. Parameters define what types of +arguments a function can accept. For example, given the function definition:: + + def func(foo, bar=None, **kwargs): + pass + +*foo*, *bar* and *kwargs* are parameters of ``func``. However, when calling +``func``, for example:: + + func(42, bar=314, extra=somevar) + +the values ``42``, ``314``, and ``somevar`` are arguments. + + How do I write a function with output parameters (call by reference)? --------------------------------------------------------------------- |