]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-43705: Document that SyntaxError's offsets are 1-indexed (GH-25153)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 2 Apr 2021 22:26:32 +0000 (15:26 -0700)
committerGitHub <noreply@github.com>
Fri, 2 Apr 2021 22:26:32 +0000 (15:26 -0700)
Changed the inline mentions of the attributes into a proper attribute list like `SystemExit` has.

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

Co-authored-by: Ammar Askar <ammar@ammaraskar.com>
Doc/library/exceptions.rst

index df2cda9d67ad153971e374db1eef138ffe8d44da..28d1ab150c8706691916186e066c695e9744c5ca 100644 (file)
@@ -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