Skip to content

Commit

Permalink
bpo-43705: Document that SyntaxError's offsets are 1-indexed (GH-25153)
Browse files Browse the repository at this point in the history
Changed the inline mentions of the attributes into a proper attribute list like `SystemExit` has.

Automerge-Triggered-By: GH:gvanrossum
(cherry picked from commit b2a91e0)

Co-authored-by: Ammar Askar <ammar@ammaraskar.com>
  • Loading branch information
miss-islington and ammaraskar committed Apr 2, 2021
1 parent a44771f commit 06653f8
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions Doc/library/exceptions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -397,9 +397,25 @@ The following exceptions are the exceptions that are usually raised.
or :func:`eval`, or when reading the initial script or standard input
(also interactively).

Instances of this class have attributes :attr:`filename`, :attr:`lineno`,
:attr:`offset` and :attr:`text` for easier access to the details. :func:`str`
of the exception instance returns only the message.
The :func:`str` of the exception instance returns only the error message.

.. attribute:: filename

The name of the file the syntax error occurred in.

.. attribute:: lineno

Which line number in the file the error occurred in. This is
1-indexed: the first line in the file has a ``lineno`` of 1.

.. attribute:: offset

The column in the line where the error occurred. This is
1-indexed: the first character in the line has an ``offset`` of 1.

.. attribute:: text

The source code text involved in the error.


.. exception:: IndentationError
Expand Down

0 comments on commit 06653f8

Please sign in to comment.