Skip to content

gh-128481: Add missing documentation for traceback.FrameSummary #128484

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

Merged
merged 7 commits into from
Mar 2, 2025

Conversation

Damien-Chen
Copy link
Contributor

@Damien-Chen Damien-Chen commented Jan 4, 2025

@ZeroIntensity ZeroIntensity added needs backport to 3.13 bugs and security fixes needs backport to 3.12 only security fixes labels Jan 4, 2025
picnixz
picnixz previously requested changes Jan 4, 2025
@Damien-Chen
Copy link
Contributor Author

end_lineno cannot have a default None as well ?

There is no description for the colno, end_lineno and endcolno in the __init__ function, should I add the documentation for all the above argument ?

`
.. attribute:: FrameSummary.end_lineno

  The last line number of the source code for this frame.

.. attribute:: FrameSummary.colno

  The column number of the source code for this frame.

.. attribute:: FrameSummary.end_colno

  The last column number of the source code for this frame.

`

@picnixz
Copy link
Member

picnixz commented Jan 4, 2025

end_lineno cannot have a default None as well ?

No, I meant it cannot have a default value without name having one. The problem was where it was put in the signature.

@Damien-Chen
Copy link
Contributor Author

Understood, I have fixed it with latest commit.

@Damien-Chen Damien-Chen requested a review from picnixz January 4, 2025 15:43
@picnixz
Copy link
Member

picnixz commented Mar 1, 2025

Do you want a final look @ZeroIntensity before I merge it?

@Damien-Chen
Copy link
Contributor Author

Of course.

Copy link
Member

@ZeroIntensity ZeroIntensity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm good with it :)

@picnixz picnixz self-assigned this Mar 1, 2025
@picnixz picnixz changed the title gh-128481: Add missing documentation for traceback.FrameSummary.end_{col,line} gh-128481: Add missing documentation for traceback.FrameSummary.end_{col,line}no Mar 2, 2025
@picnixz picnixz changed the title gh-128481: Add missing documentation for traceback.FrameSummary.end_{col,line}no gh-128481: Add missing documentation for traceback.FrameSummary Mar 2, 2025
@picnixz picnixz merged commit 051f0e5 into python:main Mar 2, 2025
24 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Mar 2, 2025
@miss-islington-app
Copy link

Thanks @Damien-Chen for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

@picnixz
Copy link
Member

picnixz commented Mar 2, 2025

Thank you!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request 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]>
@bedevere-app
Copy link

bedevere-app bot commented Mar 2, 2025

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

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Mar 2, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request 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]>
@bedevere-app
Copy link

bedevere-app bot commented Mar 2, 2025

GH-130754 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Mar 2, 2025
picnixz pushed a commit that referenced this pull request 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 pull request 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]>
@Damien-Chen Damien-Chen deleted the ph-1 branch March 8, 2025 02:57
seehwan pushed a commit to seehwan/cpython that referenced this pull request Apr 16, 2025
…ython#128484)

Complete the `traceback.FrameSummary` signature and add missing
documentation for the `colno` and `end_{col,line}no` attributes.
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 skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants