]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] gh-101100: Further improve docs on function attributes (GH-113001) (#113030)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 12 Dec 2023 20:28:10 +0000 (21:28 +0100)
committerGitHub <noreply@github.com>
Tue, 12 Dec 2023 20:28:10 +0000 (20:28 +0000)
gh-101100: Further improve docs on function attributes (GH-113001)
(cherry picked from commit 81a15ea74e2607728fceb822dfcc1aabff00478a)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Doc/c-api/function.rst
Doc/reference/datamodel.rst

index 75a05b4197c460f3fee861f7e22795d75382754c..e7fb5090c0993399870abda8bc4dfba9cb94f1e5 100644 (file)
@@ -35,7 +35,7 @@ There are a few functions specific to Python functions.
    must be a dictionary with the global variables accessible to the function.
 
    The function's docstring and name are retrieved from the code object.
-   :func:`~function.__module__`
+   :attr:`~function.__module__`
    is retrieved from *globals*. The argument defaults, annotations and closure are
    set to ``NULL``. :attr:`~function.__qualname__` is set to the same value as
    the code object's :attr:`~codeobject.co_qualname` field.
index db4baf4b6ec6fbc3493c60c6aedc0796b7a1d2fd..35d295ce139610826dde29ab14408171af95a89f 100644 (file)
@@ -601,7 +601,7 @@ Most of these attributes check the type of the assigned value:
        or ``None`` if unavailable.
 
    * - .. attribute:: function.__defaults__
-     - A :class:`tuple` containing default parameter values
+     - A :class:`tuple` containing default :term:`parameter` values
        for those parameters that have defaults,
        or ``None`` if no parameters have a default value.
 
@@ -614,19 +614,22 @@ Most of these attributes check the type of the assigned value:
        See also: :attr:`__dict__ attributes <object.__dict__>`.
 
    * - .. attribute:: function.__annotations__
-     - A :class:`dictionary <dict>` containing annotations of parameters.
+     - A :class:`dictionary <dict>` containing annotations of
+       :term:`parameters <parameter>`.
        The keys of the dictionary are the parameter names,
        and ``'return'`` for the return annotation, if provided.
        See also: :ref:`annotations-howto`.
 
    * - .. attribute:: function.__kwdefaults__
      - A :class:`dictionary <dict>` containing defaults for keyword-only
-       parameters.
+       :term:`parameters <parameter>`.
 
    * - .. attribute:: function.__type_params__
      - A :class:`tuple` containing the :ref:`type parameters <type-params>` of
        a :ref:`generic function <generic-functions>`.
 
+       .. versionadded:: 3.12
+
 Function objects also support getting and setting arbitrary attributes, which
 can be used, for example, to attach metadata to functions.  Regular attribute
 dot-notation is used to get and set such attributes.