summaryrefslogtreecommitdiffstats
path: root/Doc/c-api
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2016-05-10 06:43:53 (GMT)
committerBenjamin Peterson <benjamin@python.org>2016-05-10 06:43:53 (GMT)
commit387235085c5a6a1d823b0af3fabb42830c88f984 (patch)
tree3972389e6df640a250785b64599acfe35227571a /Doc/c-api
parent78b5ed98d811f3d158ce27c784269140defe6ec7 (diff)
downloadcpython-387235085c5a6a1d823b0af3fabb42830c88f984.zip
cpython-387235085c5a6a1d823b0af3fabb42830c88f984.tar.gz
cpython-387235085c5a6a1d823b0af3fabb42830c88f984.tar.bz2
improve PyFunction_New docs (closes #26986)
Patch from Xiang Zhang.
Diffstat (limited to 'Doc/c-api')
-rw-r--r--Doc/c-api/function.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/Doc/c-api/function.rst b/Doc/c-api/function.rst
index 4c74dc8..17279c7 100644
--- a/Doc/c-api/function.rst
+++ b/Doc/c-api/function.rst
@@ -34,8 +34,9 @@ There are a few functions specific to Python functions.
Return a new function object associated with the code object *code*. *globals*
must be a dictionary with the global variables accessible to the function.
- The function's docstring, name and *__module__* are retrieved from the code
- object, the argument defaults and closure are set to *NULL*.
+ The function's docstring and name are retrieved from the code object. *__module__*
+ is retrieved from *globals*. The argument defaults, annotations and closure are
+ set to *NULL*. *__qualname__* is set to the same value as the function's name.
.. c:function:: PyObject* PyFunction_NewWithQualName(PyObject *code, PyObject *globals, PyObject *qualname)