Skip to content

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

Merged
picnixz merged 7 commits into
python:mainfrom
Damien-Chen:ph-1
Mar 2, 2025
Merged

gh-128481: Add missing documentation for traceback.FrameSummary#128484
picnixz merged 7 commits into
python:mainfrom
Damien-Chen:ph-1

Conversation

@Damien-Chen

@Damien-ChenDamien-Chen commented Jan 4, 2025•
edited by ZeroIntensity
Loading

Copy link
Copy Markdown
Contributor

@bedevere-appbedevere-appBot added docs Documentation in the Doc dir skip news labels Jan 4, 2025
@bedevere-appbedevere-appBot mentioned this pull request Jan 4, 2025
Closed
ZeroIntensity
ZeroIntensity reviewed Jan 4, 2025
View reviewed changes
Comment threadDoc/library/traceback.rst Outdated
ZeroIntensity
ZeroIntensity reviewed Jan 4, 2025
View reviewed changes
Comment threadDoc/library/traceback.rst
Comment threadDoc/library/traceback.rst Outdated
@ZeroIntensityZeroIntensity 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
View reviewed changes
Comment threadDoc/library/traceback.rst Outdated
@Damien-Chen

Damien-Chen commented Jan 4, 2025

Copy link
Copy Markdown
ContributorAuthor

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

picnixz commented Jan 4, 2025

Copy link
Copy Markdown
Member

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

Damien-Chen commented Jan 4, 2025

Copy link
Copy Markdown
ContributorAuthor

Understood, I have fixed it with latest commit.

picnixz
picnixz reviewed Jan 11, 2025
View reviewed changes
Comment threadDoc/library/traceback.rst Outdated
Comment threadDoc/library/traceback.rst
@picnixz
picnixz dismissed their stale reviewJanuary 11, 2025 17:00

Changes were made.

picnixz
picnixz reviewed Mar 1, 2025
View reviewed changes
Comment threadDoc/library/traceback.rst Outdated
Comment threadDoc/library/traceback.rst Outdated
Comment threadDoc/library/traceback.rst Outdated
Comment threadDoc/library/traceback.rst Outdated
Comment threadDoc/library/traceback.rst
picnixz
picnixz reviewed Mar 1, 2025
View reviewed changes
Comment threadDoc/library/traceback.rst Outdated
picnixz
picnixz reviewed Mar 1, 2025
View reviewed changes
Comment threadDoc/library/traceback.rst
picnixz
picnixz reviewed Mar 1, 2025
View reviewed changes
Comment threadDoc/library/traceback.rst Outdated
@picnixz

picnixz commented Mar 1, 2025•
edited
Loading

Copy link
Copy Markdown
Member

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

@Damien-Chen

Damien-Chen commented Mar 1, 2025

Copy link
Copy Markdown
ContributorAuthor

Of course.

ZeroIntensity
ZeroIntensity approved these changes Mar 1, 2025
View reviewed changes

@ZeroIntensityZeroIntensity left a comment

Copy link
Copy Markdown
Member

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 :)

@picnixzpicnixz self-assigned this Mar 1, 2025
@picnixzpicnixz 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}noMar 2, 2025
@picnixzpicnixz changed the title gh-128481: Add missing documentation for traceback.FrameSummary.end_{col,line}nogh-128481: Add missing documentation for traceback.FrameSummaryMar 2, 2025
@picnixz
picnixz merged commit 051f0e5 into python:mainMar 2, 2025
@github-project-automationgithub-project-automationBot moved this from Todo to Done in Docs PRsMar 2, 2025
@miss-islington-app

miss-islington-appBot commented Mar 2, 2025

Copy link
Copy Markdown

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

picnixz commented Mar 2, 2025

Copy link
Copy Markdown
Member

Thank you!

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 2, 2025
@Damien-Chen@miss-islington
pythongh-128481: Improve documentation fortraceback.FrameSummary(p…
1f232ad
…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 <81557462+Damien-Chen@users.noreply.github.com>
@bedevere-app

bedevere-appBot commented Mar 2, 2025

Copy link
Copy Markdown

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

@bedevere-appbedevere-appBot 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
@Damien-Chen@miss-islington
pythongh-128481: Improve documentation fortraceback.FrameSummary(p…
a1d087c
…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 <81557462+Damien-Chen@users.noreply.github.com>
@bedevere-app

bedevere-appBot commented Mar 2, 2025

Copy link
Copy Markdown

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

@bedevere-appbedevere-appBot 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
@miss-islington@Damien-Chen
[3.13]gh-128481: Improve documentation fortraceback.FrameSummary(G…
dca599e
…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 <81557462+Damien-Chen@users.noreply.github.com>
picnixz pushed a commit that referenced this pull request Mar 2, 2025
@miss-islington@Damien-Chen
[3.12]gh-128481: Improve documentation fortraceback.FrameSummary(G…
a0676db
…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 <81557462+Damien-Chen@users.noreply.github.com>
@Damien-Chen
Damien-Chen deleted the ph-1 branch March 8, 2025 02:57
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@picnixzpicnixzpicnixz approved these changes
@ZeroIntensityZeroIntensityZeroIntensity approved these changes

Assignees

@picnixzpicnixz

Labels

docsDocumentation in the Doc dirskip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Damien-Chen@picnixz@ZeroIntensity