https://github.com/python/cpython/commit/09aebb1fbc0c1d771d4942844d5e2077fcdf56c9
commit: 09aebb1fbc0c1d771d4942844d5e2077fcdf56c9
branch: main
author: Tomas R <[email protected]>
committer: JelleZijlstra <[email protected]>
date: 2024-09-26T06:38:25-07:00
summary:
gh-118181: Fix parameter markup in AST docs (#124473)
files:
M Doc/library/ast.rst
diff --git a/Doc/library/ast.rst b/Doc/library/ast.rst
index a8a18ad31fb773..a9518859b83478 100644
--- a/Doc/library/ast.rst
+++ b/Doc/library/ast.rst
@@ -178,9 +178,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::
@@ -199,7 +199,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::
@@ -214,7 +214,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::
@@ -243,9 +243,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::
@@ -1771,9 +1771,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``.
@@ -1801,8 +1801,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::
@@ -1836,8 +1836,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::
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
