From: Erlend E. Aasland <erlend@python.org>
Date: Wed, 28 Feb 2024 13:03:50 +0000 (+0100)
Subject: gh-78612: Mark up eval() using param list (#115212)
X-Git-Tag: v3.13.0a5~207
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=a71e32ce8e183023fc1ee401c22ebe35e4832f09;p=thirdparty%2FPython%2Fcpython.git

gh-78612: Mark up eval() using param list (#115212)

Also mention that the 'expression' parameter can be a string.
---

diff --git a/Doc/library/functions.rst b/Doc/library/functions.rst
index a4852b922b65..e598ef423de4 100644
--- a/Doc/library/functions.rst
+++ b/Doc/library/functions.rst
@@ -526,9 +526,20 @@ are always available.  They are listed here in alphabetical order.
 
 .. function:: eval(expression, globals=None, locals=None)
 
-   The arguments are a string and optional globals and locals.  If provided,
-   *globals* must be a dictionary.  If provided, *locals* can be any mapping
-   object.
+   :param expression:
+      A Python expression.
+   :type expression: :class:`str` | :ref:`code object <code-objects>`
+
+   :param globals:
+      The global namespace (default: ``None``).
+   :type globals: :class:`dict` | ``None``
+
+   :param locals:
+      The local namespace (default: ``None``).
+   :type locals: :term:`mapping` | ``None``
+
+   :returns: The result of the evaluated expression.
+   :raises: Syntax errors are reported as exceptions.
 
    The *expression* argument is parsed and evaluated as a Python expression
    (technically speaking, a condition list) using the *globals* and *locals*
@@ -545,8 +556,7 @@ are always available.  They are listed here in alphabetical order.
    :term:`nested scopes <nested scope>` (non-locals) in the enclosing
    environment.
 
-   The return value is the result of
-   the evaluated expression. Syntax errors are reported as exceptions.  Example:
+   Example:
 
       >>> x = 1
       >>> eval('x+1')