bpo-27910: Update documentation of the traceback module by torsava · Pull Request #6116 · python/cpython (original) (raw)
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 andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Conversation9 Commits6 Checks0 Files changed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
[ Show hidden characters]({{ revealButtonHref }})
From my brief look into git history, docs changes don't usually get a NEWS entry, so I've omitted it.
| information that is usually printed for a stack trace. The *text* is a |
|---|
| string with leading and trailing whitespace stripped; if the source is |
| not available it is ``None``. |
| Returns a :class:`StackSummary` object representing a list of "pre-processed" |
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The imperative form Return is preferred.
With these changes, the documentation and docstrings are out of sync, so those may need to be updated as well.
I went ahead and addressed @csabella's review comments. I will merge this once Travis and AppVeyor builds are finished.
Thanks @torsava for the PR, and @berkerpeksag for merging it 🌮🎉.. I'm working now to backport this PR to: 3.6, 3.7.
🐍🍒⛏🤖
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request
In the documentation for the traceback module, the definitions of functions extract_tb(), format_list() and classmethod StackSummary.from_list() mention the old style 4-tuples that these functions used to return or accept.
Since Python 3.5, however, they return or accept a FrameSummary object instead of a 4-tuple, or a StackSummary object instead of a list of 4-tuples.
Co-Authored-By: Berker Peksag berker.peksag@gmail.com (cherry picked from commit f394ee5)
Co-authored-by: torsava torsava@redhat.com
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request
In the documentation for the traceback module, the definitions of functions extract_tb(), format_list() and classmethod StackSummary.from_list() mention the old style 4-tuples that these functions used to return or accept.
Since Python 3.5, however, they return or accept a FrameSummary object instead of a 4-tuple, or a StackSummary object instead of a list of 4-tuples.
Co-Authored-By: Berker Peksag berker.peksag@gmail.com (cherry picked from commit f394ee5)
Co-authored-by: torsava torsava@redhat.com
berkerpeksag pushed a commit that referenced this pull request
In the documentation for the traceback module, the definitions of functions extract_tb(), format_list() and classmethod StackSummary.from_list() mention the old style 4-tuples that these functions used to return or accept.
Since Python 3.5, however, they return or accept a FrameSummary object instead of a 4-tuple, or a StackSummary object instead of a list of 4-tuples.
Co-authored-by: torsava torsava@redhat.com Co-Authored-By: Berker Peksag berker.peksag@gmail.com
(cherry picked from commit f394ee5)
berkerpeksag added a commit that referenced this pull request
In the documentation for the traceback module, the definitions of functions extract_tb(), format_list() and classmethod StackSummary.from_list() mention the old style 4-tuples that these functions used to return or accept.
Since Python 3.5, however, they return or accept a FrameSummary object instead of a 4-tuple, or a StackSummary object instead of a list of 4-tuples.
Co-authored-by: torsava torsava@redhat.com Co-Authored-By: Berker Peksag berker.peksag@gmail.com (cherry picked from commit f394ee5)