diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2023-06-05 17:02:14 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-05 17:02:14 (GMT) |
| commit | ab660e9a53090f6b00b33ff0633b0388355f4c4a (patch) | |
| tree | df8abe8481c516ce8325a9f5909a5de06e3ecc7f | |
| parent | 05b615345699c9d0dcff0b638b8eb9bd596c0cb7 (diff) | |
| download | cpython-ab660e9a53090f6b00b33ff0633b0388355f4c4a.zip cpython-ab660e9a53090f6b00b33ff0633b0388355f4c4a.tar.gz cpython-ab660e9a53090f6b00b33ff0633b0388355f4c4a.tar.bz2 | |
[3.12] gh-89412: Add missing attributes (added in 3.10) to traceback module docs (GH-105046) (#105327)
(cherry picked from commit a4f72fa39a9d391c7b931ba1906d81da4ae01949)
Co-authored-by: Jakub Kuczys <me@jacken.men>
| -rw-r--r-- | Doc/library/traceback.rst | 14 | ||||
| -rw-r--r-- | Lib/traceback.py | 4 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2023-05-28-19-08-42.gh-issue-89412.j4cg7K.rst | 2 |
3 files changed, 18 insertions, 2 deletions
diff --git a/Doc/library/traceback.rst b/Doc/library/traceback.rst index 58f4781..36171a3 100644 --- a/Doc/library/traceback.rst +++ b/Doc/library/traceback.rst @@ -279,6 +279,13 @@ capture data for later printing in a lightweight fashion. For syntax errors - the line number where the error occurred. + .. attribute:: end_lineno + + For syntax errors - the end line number where the error occurred. + Can be ``None`` if not present. + + .. versionadded:: 3.10 + .. attribute:: text For syntax errors - the text where the error occurred. @@ -287,6 +294,13 @@ capture data for later printing in a lightweight fashion. For syntax errors - the offset into the text where the error occurred. + .. attribute:: end_offset + + For syntax errors - the end offset into the text where the error occurred. + Can be ``None`` if not present. + + .. versionadded:: 3.10 + .. attribute:: msg For syntax errors - the compiler error message. diff --git a/Lib/traceback.py b/Lib/traceback.py index 0ea77bf..21e3204 100644 --- a/Lib/traceback.py +++ b/Lib/traceback.py @@ -674,8 +674,8 @@ class TracebackException: occurred. - :attr:`offset` For syntax errors - the offset into the text where the error occurred. - - :attr:`end_offset` For syntax errors - the offset into the text where the - error occurred. Can be `None` if not present. + - :attr:`end_offset` For syntax errors - the end offset into the text where + the error occurred. Can be `None` if not present. - :attr:`msg` For syntax errors - the compiler error message. """ diff --git a/Misc/NEWS.d/next/Documentation/2023-05-28-19-08-42.gh-issue-89412.j4cg7K.rst b/Misc/NEWS.d/next/Documentation/2023-05-28-19-08-42.gh-issue-89412.j4cg7K.rst new file mode 100644 index 0000000..00937e5 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2023-05-28-19-08-42.gh-issue-89412.j4cg7K.rst @@ -0,0 +1,2 @@ +Add missing documentation for the ``end_lineno`` and ``end_offset`` attributes +of the :class:`traceback.TracebackException` class. |