diff options
author | Ammar Askar <ammar@ammaraskar.com> | 2021-04-02 21:25:31 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-04-02 21:25:31 (GMT) |
commit | b2a91e0c9ee18b50cc86b21211c2258520a9f5d0 (patch) | |
tree | 5006f761ba4ebd82a9443009158eb41786bee4b9 | |
parent | f97dc800689ba98783dac8dc51f87f7c6f413ac6 (diff) | |
download | cpython-b2a91e0c9ee18b50cc86b21211c2258520a9f5d0.zip cpython-b2a91e0c9ee18b50cc86b21211c2258520a9f5d0.tar.gz cpython-b2a91e0c9ee18b50cc86b21211c2258520a9f5d0.tar.bz2 |
bpo-43705: Document that SyntaxError's offsets are 1-indexed (GH-25153)
Changed the inline mentions of the attributes into a proper attribute list like `SystemExit` has.
Automerge-Triggered-By: GH:gvanrossum
-rw-r--r-- | Doc/library/exceptions.rst | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst index 40ccde7..4dea670 100644 --- a/Doc/library/exceptions.rst +++ b/Doc/library/exceptions.rst @@ -402,9 +402,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 |