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.

Sign up for GitHub

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
Merged

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

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
95c6aaf
Add missing documentation for FrameSummary
Damien-Chen Jan 4, 2025
01a1727
Add missing documentation and reformat
Damien-Chen Jan 4, 2025
b545299
Modify as reviewer suggested
Damien-Chen Jan 12, 2025
5bbeb70
modify document as reviewer suggested
Damien-Chen Mar 1, 2025
de65b3f
Merge branch 'main' into ph-1
Damien-Chen Mar 1, 2025
0513969
modify document as reviewer suggested
Damien-Chen Mar 1, 2025
6592448
Change the starting index of column
Damien-Chen Mar 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion Doc/library/traceback.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,7 +503,7 @@ the module-level functions described above.
A :class:`!FrameSummary` object represents a single :ref:`frame <frame-objects>`
in a :ref:`traceback <traceback-objects>`.

.. class:: FrameSummary(filename, lineno, name, lookup_line=True, locals=None, line=None)
.. class:: FrameSummary(filename, lineno, end_lineno=None, name, lookup_line=True, locals=None, line=None, end_colno=None)

Represents a single :ref:`frame <frame-objects>` in the
:ref:`traceback <traceback-objects>` or stack that is being formatted
Expand All @@ -528,6 +528,10 @@ in a :ref:`traceback <traceback-objects>`.

The line number of the source code for this frame.

.. attribute:: FrameSummary.end_lineno

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

.. attribute:: FrameSummary.name

Equivalent to accessing :attr:`f.f_code.co_name <codeobject.co_name>` on
Expand All @@ -539,6 +543,9 @@ in a :ref:`traceback <traceback-objects>`.
trailing whitespace stripped.
If the source is not available, it is ``None``.

.. attribute:: FrameSummary.end_colno
The last column number of the source code for this frame.

.. _traceback-example:

Examples of Using the Module-Level Functions
Expand Down
Loading