]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.13] gh-118181: Fix parameter markup in AST docs (GH-124473) (#124600)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Thu, 26 Sep 2024 20:52:37 +0000 (22:52 +0200)
committerGitHub <noreply@github.com>
Thu, 26 Sep 2024 20:52:37 +0000 (13:52 -0700)
gh-118181: Fix parameter markup in AST docs (GH-124473)
(cherry picked from commit 09aebb1fbc0c1d771d4942844d5e2077fcdf56c9)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
Doc/library/ast.rst

index d10da5e0475cab7cd0286b456526d6f8c214fbf2..0b7d56286b232a68c8828a1808c0385564a48108 100644 (file)
@@ -173,9 +173,9 @@ Root nodes
    A Python module, as with :ref:`file input <file-input>`.
    Node type generated by :func:`ast.parse` in the default ``"exec"`` *mode*.
 
-   *body* is a :class:`list` of the module's :ref:`ast-statements`.
+   ``body`` is a :class:`list` of the module's :ref:`ast-statements`.
 
-   *type_ignores* is a :class:`list` of the module's type ignore comments;
+   ``type_ignores`` is a :class:`list` of the module's type ignore comments;
    see :func:`ast.parse` for more details.
 
    .. doctest::
@@ -194,7 +194,7 @@ Root nodes
    A single Python :ref:`expression input <expression-input>`.
    Node type generated by :func:`ast.parse` when *mode* is ``"eval"``.
 
-   *body* is a single node,
+   ``body`` is a single node,
    one of the :ref:`expression types <ast-expressions>`.
 
    .. doctest::
@@ -209,7 +209,7 @@ Root nodes
    A single :ref:`interactive input <interactive>`, like in :ref:`tut-interac`.
    Node type generated by :func:`ast.parse` when *mode* is ``"single"``.
 
-   *body* is a :class:`list` of :ref:`statement nodes <ast-statements>`.
+   ``body`` is a :class:`list` of :ref:`statement nodes <ast-statements>`.
 
    .. doctest::
 
@@ -238,9 +238,9 @@ Root nodes
            # type: (int, int) -> int
            return a + b
 
-   *argtypes* is a :class:`list` of :ref:`expression nodes <ast-expressions>`.
+   ``argtypes`` is a :class:`list` of :ref:`expression nodes <ast-expressions>`.
 
-   *returns* is a single :ref:`expression node <ast-expressions>`.
+   ``returns`` is a single :ref:`expression node <ast-expressions>`.
 
    .. doctest::
 
@@ -1766,9 +1766,9 @@ aliases.
 
 .. class:: TypeVar(name, bound, default_value)
 
-   A :class:`typing.TypeVar`. *name* is the name of the type variable.
-   *bound* is the bound or constraints, if any. If *bound* is a :class:`Tuple`,
-   it represents constraints; otherwise it represents the bound. *default_value*
+   A :class:`typing.TypeVar`. ``name`` is the name of the type variable.
+   ``bound`` is the bound or constraints, if any. If ``bound`` is a :class:`Tuple`,
+   it represents constraints; otherwise it represents the bound. ``default_value``
    is the default value; if the :class:`!TypeVar` has no default, this
    attribute will be set to ``None``.
 
@@ -1796,8 +1796,8 @@ aliases.
 
 .. class:: ParamSpec(name, default_value)
 
-   A :class:`typing.ParamSpec`. *name* is the name of the parameter specification.
-   *default_value* is the default value; if the :class:`!ParamSpec` has no default,
+   A :class:`typing.ParamSpec`. ``name`` is the name of the parameter specification.
+   ``default_value`` is the default value; if the :class:`!ParamSpec` has no default,
    this attribute will be set to ``None``.
 
    .. doctest::
@@ -1831,8 +1831,8 @@ aliases.
 
 .. class:: TypeVarTuple(name, default_value)
 
-   A :class:`typing.TypeVarTuple`. *name* is the name of the type variable tuple.
-   *default_value* is the default value; if the :class:`!TypeVarTuple` has no
+   A :class:`typing.TypeVarTuple`. ``name`` is the name of the type variable tuple.
+   ``default_value`` is the default value; if the :class:`!TypeVarTuple` has no
    default, this attribute will be set to ``None``.
 
    .. doctest::