[Python-checkins] Minor docs improvements fix for `codeop` (GH-103123)
miss-islington
webhook-mailer at python.org
Thu Mar 30 18:59:01 EDT 2023
https://github.com/python/cpython/commit/41e3ea13964bffa6ec9b0e036d70b6b8e9f2e120
commit: 41e3ea13964bffa6ec9b0e036d70b6b8e9f2e120
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2023-03-30T15:58:54-07:00
summary:
Minor docs improvements fix for `codeop` (GH-103123)
(cherry picked from commit c1e71ce56fdb3eab62ad3190d09130f800e54610)
Co-authored-by: gaogaotiantian <gaogaotiantian at hotmail.com>
files:
M Doc/library/codeop.rst
diff --git a/Doc/library/codeop.rst b/Doc/library/codeop.rst
index c66b9d3ec0a2..90df499f8207 100644
--- a/Doc/library/codeop.rst
+++ b/Doc/library/codeop.rst
@@ -19,10 +19,10 @@ module instead.
There are two parts to this job:
-#. Being able to tell if a line of input completes a Python statement: in
+#. Being able to tell if a line of input completes a Python statement: in
short, telling whether to print '``>>>``' or '``...``' next.
-#. Remembering which future statements the user has entered, so subsequent
+#. Remembering which future statements the user has entered, so subsequent
input can be compiled with these in effect.
The :mod:`codeop` module provides a way of doing each of these things, and a way
@@ -33,9 +33,9 @@ To do just the former:
.. function:: compile_command(source, filename="<input>", symbol="single")
Tries to compile *source*, which should be a string of Python code and return a
- code object if *source* is valid Python code. In that case, the filename
+ code object if *source* is valid Python code. In that case, the filename
attribute of the code object will be *filename*, which defaults to
- ``'<input>'``. Returns ``None`` if *source* is *not* valid Python code, but is a
+ ``'<input>'``. Returns ``None`` if *source* is *not* valid Python code, but is a
prefix of valid Python code.
If there is a problem with *source*, an exception will be raised.
@@ -43,9 +43,9 @@ To do just the former:
:exc:`OverflowError` or :exc:`ValueError` if there is an invalid literal.
The *symbol* argument determines whether *source* is compiled as a statement
- (``'single'``, the default), as a sequence of statements (``'exec'``) or
+ (``'single'``, the default), as a sequence of :term:`statement` (``'exec'``) or
as an :term:`expression` (``'eval'``). Any other value will
- cause :exc:`ValueError` to be raised.
+ cause :exc:`ValueError` to be raised.
.. note::
@@ -69,5 +69,5 @@ To do just the former:
Instances of this class have :meth:`__call__` methods identical in signature to
:func:`compile_command`; the difference is that if the instance compiles program
- text containing a ``__future__`` statement, the instance 'remembers' and
+ text containing a :mod:`__future__` statement, the instance 'remembers' and
compiles all subsequent program texts with the statement in force.
More information about the Python-checkins
mailing list