[Python-checkins] bpo-43705: Document that SyntaxError's offsets are 1-indexed (GH-25153)
miss-islington
webhook-mailer at python.org
Fri Apr 2 17:25:39 EDT 2021
https://github.com/python/cpython/commit/b2a91e0c9ee18b50cc86b21211c2258520a9f5d0
commit: b2a91e0c9ee18b50cc86b21211c2258520a9f5d0
branch: master
author: Ammar Askar <ammar at ammaraskar.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2021-04-02T14:25:31-07:00
summary:
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
files:
M Doc/library/exceptions.rst
diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst
index 40ccde72d07cc..4dea6701a6bfd 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
More information about the Python-checkins
mailing list