Skip to content

[Doc] Minor doc fix for codeop #103123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 30, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions Doc/library/codeop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -33,19 +33,19 @@ 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.
:exc:`SyntaxError` is raised if there is invalid Python syntax, and
: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::

Expand All @@ -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.