[Python-checkins] bpo-43705: Document that SyntaxError's offsets are 1-indexed (GH-25153)

[miss-islington]

https://github.com/python/cpython/commit/63c69440c7adb0de1d191a8d3d100b335d5c2f81
commit: 63c69440c7adb0de1d191a8d3d100b335d5c2f81
branch: 3.9
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2021-04-02T15:26:32-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
(cherry picked from commit b2a91e0c9ee18b50cc86b21211c2258520a9f5d0)

Co-authored-by: Ammar Askar <ammar at ammaraskar.com>

files:
M Doc/library/exceptions.rst

diff --git a/Doc/library/exceptions.rst b/Doc/library/exceptions.rst
index df2cda9d67ad1..28d1ab150c870 100644
--- a/Doc/library/exceptions.rst
+++ b/Doc/library/exceptions.rst
@@ -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