Skip to content

Missing documentation for traceback.FrameSummary.end_{col,line}no attributes #128481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Zac-HD opened this issue Jan 4, 2025 · 3 comments
Closed
Labels
docs Documentation in the Doc dir easy

Comments

@Zac-HD
Copy link
Contributor

Zac-HD commented Jan 4, 2025

These attributes were added in Python 3.11, as part of PEP-657, and I believe they're intended to be public API. If so, adding them to the __init__ docstring would be nice!

(prompted by checking typeshed, which includes them, while reviewing https://peps.python.org/pep-0657/)

Linked PRs

@Zac-HD Zac-HD added the docs Documentation in the Doc dir label Jan 4, 2025
@ZeroIntensity
Copy link
Member

PR welcome :)

@Ko496-glitch
Copy link

@Zac-HD hey can i take this issue and do the document for the attributes that were added?

@AA-Turner
Copy link
Member

There's an existing PR here from Damien, but don't let that deter you from working on something else!

A

picnixz pushed a commit that referenced this issue Mar 2, 2025
Complete the `traceback.FrameSummary` signature and add missing
documentation for the `colno` and `end_{col,line}no` attributes.
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 2, 2025
…ythonGH-128484)

Complete the `traceback.FrameSummary` signature and add missing
documentation for the `colno` and `end_{col,line}no` attributes.
(cherry picked from commit 051f0e5)

Co-authored-by: Damien <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 2, 2025
…ythonGH-128484)

Complete the `traceback.FrameSummary` signature and add missing
documentation for the `colno` and `end_{col,line}no` attributes.
(cherry picked from commit 051f0e5)

Co-authored-by: Damien <[email protected]>
picnixz pushed a commit that referenced this issue Mar 2, 2025
…H-128484) (#130753)

* gh-128481: Improve documentation for `traceback.FrameSummary` (GH-128484)

Complete the `traceback.FrameSummary` signature and add missing
documentation for the `colno` and `end_{col,line}no` attributes.
(cherry picked from commit 051f0e5)

Co-authored-by: Damien <[email protected]>
picnixz pushed a commit that referenced this issue Mar 2, 2025
…H-128484) (#130754)

* gh-128481: Improve documentation for `traceback.FrameSummary` (GH-128484)

Complete the `traceback.FrameSummary` signature and add missing
documentation for the `colno` and `end_{col,line}no` attributes.
(cherry picked from commit 051f0e5)

Co-authored-by: Damien <[email protected]>
picnixz added a commit that referenced this issue Mar 2, 2025
…no` changed in 3.13 (#130755)

The value taken by `FrameSummary.end_lineno` when passing `end_lineno=None` changed in gh-112097.

Previously, a `end_lineno` could be specified to be `None` directly but since 939fc6d, passing None makes
the constructor use the value of `lineno` instead.
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Mar 2, 2025
…d_lineno` changed in 3.13 (pythonGH-130755)

The value taken by `FrameSummary.end_lineno` when passing `end_lineno=None` changed in pythongh-112097.

Previously, a `end_lineno` could be specified to be `None` directly but since 939fc6d, passing None makes
the constructor use the value of `lineno` instead.
(cherry picked from commit c6513f7)

Co-authored-by: Bénédikt Tran <[email protected]>
picnixz added a commit that referenced this issue Mar 2, 2025
…nd_lineno` changed in 3.13 (GH-130755) (#130767)

gh-128481: indicate that the default value for `FrameSummary.end_lineno` changed in 3.13 (GH-130755)

The value taken by `FrameSummary.end_lineno` when passing `end_lineno=None` changed in gh-112097.

Previously, a `end_lineno` could be specified to be `None` directly but since 939fc6d, passing None makes
the constructor use the value of `lineno` instead.
(cherry picked from commit c6513f7)

Co-authored-by: Bénédikt Tran <[email protected]>
@picnixz picnixz closed this as completed Mar 3, 2025
seehwan pushed a commit to seehwan/cpython that referenced this issue Apr 16, 2025
…ython#128484)

Complete the `traceback.FrameSummary` signature and add missing
documentation for the `colno` and `end_{col,line}no` attributes.
seehwan pushed a commit to seehwan/cpython that referenced this issue Apr 16, 2025
…d_lineno` changed in 3.13 (python#130755)

The value taken by `FrameSummary.end_lineno` when passing `end_lineno=None` changed in pythongh-112097.

Previously, a `end_lineno` could be specified to be `None` directly but since 939fc6d, passing None makes
the constructor use the value of `lineno` instead.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir easy
Projects
Status: Todo
Development

No branches or pull requests

5 participants