gh-145896: Fix typos and stale docstrings in `Lib/traceback.py` by devdanzin · Pull Request #145897 · python/cpython

devdanzin · 2026-03-13T02:13:27Z

This PR fixes some typos and stale docstrings, as described by Claude Code:

Fix stale extract_tb() docstring: add end_lineno, colno, and end_colno to the listed FrameSummary attributes (available since 3.11)
Fix stale extract_stack() docstring: replace outdated "quadruple (filename, line number, function name, text)" with "FrameSummary object" (stale since 3.5)
Fix broken grammar in FrameSummary class docstring: "for the of code" → "for the code"
Fix inaccurate _display_width() docstring: "extra amount of width" → "amount of width" (the function returns total display width, not a delta)
Fix copy-paste typo in TracebackException.__init__ comment: "exc_traceback, exc_value, exc_traceback" → "exc_type, exc_value, exc_traceback"

Issue: Typos and stale docstrings in Lib/traceback.py #145896

picnixz

Can you also check that any public doc matches this one (or is as long as the internal one) please?

devdanzin · 2026-03-22T19:37:07Z

Not sure what you mean by "is as long as the internal one", but I've corrected the same staleness and some typos in the traceback public documentation.

picnixz · 2026-03-22T19:41:59Z

By "as long as", I meant that we were precise enough in the public docs

github-actions · 2026-05-08T18:27:48Z

This PR is stale because it has been open for 30 days with no activity.

serhiy-storchaka

In general LGTM. I suggest to remove lists of FrameSummary's attribute names where we have a reference to FrameSummary,

serhiy-storchaka · 2026-05-23T09:12:29Z

   :attr:`~FrameSummary.filename`, :attr:`~FrameSummary.lineno`,
-   :attr:`~FrameSummary.name`, and :attr:`~FrameSummary.line` representing the
+   :attr:`~FrameSummary.name`, :attr:`~FrameSummary.line`,
+   :attr:`~FrameSummary.end_lineno`, :attr:`~FrameSummary.colno`, and


This is not correct, because end_lineno, colno and end_colno are not printed for a stack trace. They are used to draw the caret and underscores, but only values mentioned above are directly printed.

I do not think it is worth to enumerate the printed attributes here. We have a reference to FrameSummary which contains descriptions of all attributes. I think we can remove all attribute names here.

serhiy-storchaka · 2026-05-23T09:26:27Z

-    representing the information that is usually printed for a stack
-    trace.  The line is a string with leading and trailing
-    whitespace stripped; if the source is not available it is None.
+    containing attributes filename, lineno, name, line, end_lineno,


As above, I suggest to remove the enumeration of attributes. They are available in the FrameSummary docs.

read-the-docs-community · 2026-05-24T09:56:29Z

Documentation build overview

📚 cpython-previews | 🛠️ Build #32828306 | 📁 Comparing 9cc4bc6 against main (a38804b)

🔍 Preview build

1 file changed

± library/traceback.html

…finition with all attributes.

devdanzin · 2026-05-24T10:06:03Z

Thank for the review!

I've removed the enumerations and adapted the wording so e.g. the reference to "line" makes it clear it's an attribute.

I've avoided reflowing the text as per Bénédikt's request (makes it easier to review), please let me know whether I should reflow for the final commit.

serhiy-storchaka

LGTM. 👍

miss-islington-app · 2026-05-25T09:46:15Z

Thanks @devdanzin for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

miss-islington-app · 2026-05-25T09:46:15Z

Thanks @devdanzin for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖

miss-islington-app · 2026-05-25T09:46:15Z

Thanks @devdanzin for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

bedevere-app · 2026-05-25T09:46:28Z

GH-150382 is a backport of this pull request to the 3.14 branch.

bedevere-app · 2026-05-25T09:46:34Z

GH-150383 is a backport of this pull request to the 3.15 branch.

bedevere-app · 2026-05-25T09:46:39Z

GH-150384 is a backport of this pull request to the 3.13 branch.

…ule (GH-145897) (GH-150384) (cherry picked from commit 832afed) Co-authored-by: devdanzin <74280297+devdanzin@users.noreply.github.com>

…ule (GH-145897) (GH-150383) (cherry picked from commit 832afed) Co-authored-by: devdanzin <74280297+devdanzin@users.noreply.github.com>

…ule (GH-145897) (GH-150382) (cherry picked from commit 832afed) Co-authored-by: devdanzin <74280297+devdanzin@users.noreply.github.com>

Fix typos and stale docstrings in Lib/traceback.py.

0576ebe

bedevere-app Bot added the awaiting review label Mar 13, 2026

bedevere-app Bot mentioned this pull request Mar 13, 2026

Typos and stale docstrings in Lib/traceback.py #145896

Closed

aisk added the skip news label Mar 13, 2026

picnixz reviewed Mar 21, 2026

View reviewed changes

Comment thread Lib/traceback.py Outdated

Avoid unnecessary word placement moves.

04baa56

picnixz reviewed Mar 22, 2026

View reviewed changes

Fix a few more stale docs and typos.

5cff3a1

Avoid changing line unnecessarily.

27624a9

github-actions Bot added the stale Stale PR or inactive for long period of time. label May 8, 2026

serhiy-storchaka self-requested a review May 23, 2026 09:04

serhiy-storchaka reviewed May 23, 2026

View reviewed changes

Merge branch 'main' into traceback_typos

93fb52b

Remove attribute enumeration for FrameSummary, as it's linked to a de…

9cc4bc6

…finition with all attributes.

serhiy-storchaka approved these changes May 24, 2026

View reviewed changes

bedevere-app Bot added awaiting merge and removed awaiting review labels May 24, 2026

serhiy-storchaka merged commit 832afed into python:main May 25, 2026
99 of 101 checks passed

bedevere-app Bot removed the awaiting merge label May 25, 2026

serhiy-storchaka added docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels May 25, 2026

bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label May 25, 2026

bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label May 25, 2026

bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label May 25, 2026

Uh oh!

Conversation

devdanzin commented Mar 13, 2026 • edited by bedevere-app Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

picnixz left a comment

Choose a reason for hiding this comment

Uh oh!

devdanzin commented Mar 22, 2026

Uh oh!

picnixz commented Mar 22, 2026

Uh oh!

github-actions Bot commented May 8, 2026

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka May 23, 2026

Choose a reason for hiding this comment

Uh oh!

serhiy-storchaka May 23, 2026

Choose a reason for hiding this comment

Uh oh!

read-the-docs-community Bot commented May 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

devdanzin commented May 24, 2026

Uh oh!

serhiy-storchaka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

miss-islington-app Bot commented May 25, 2026

Uh oh!

miss-islington-app Bot commented May 25, 2026

Uh oh!

miss-islington-app Bot commented May 25, 2026

Uh oh!

bedevere-app Bot commented May 25, 2026

Uh oh!

bedevere-app Bot commented May 25, 2026

Uh oh!

bedevere-app Bot commented May 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

devdanzin commented Mar 13, 2026 •

edited by bedevere-app Bot

Loading

read-the-docs-community Bot commented May 24, 2026 •

edited

Loading