traceback.format_tb incorrect docsting

[mgedmin]

BPO	16657
Nosy	@mgedmin
Files	fix-format_tb-docstring.patch: patch

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2013-10-13.21:31:15.237>
created_at = <Date 2012-12-10.13:33:20.580>
labels = ['library']
title = 'traceback.format_tb incorrect docsting'
updated_at = <Date 2013-10-13.21:33:43.713>
user = 'https://github.com/mgedmin'

bugs.python.org fields:

activity = <Date 2013-10-13.21:33:43.713>
actor = 'python-dev'
assignee = 'none'
closed = True
closed_date = <Date 2013-10-13.21:31:15.237>
closer = 'python-dev'
components = ['Library (Lib)']
creation = <Date 2012-12-10.13:33:20.580>
creator = 'mgedmin'
dependencies = []
files = ['28276']
hgrepos = []
issue_num = 16657
keywords = ['patch']
message_count = 3.0
messages = ['177288', '199807', '199809']
nosy_count = 2.0
nosy_names = ['mgedmin', 'python-dev']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue16657'
versions = ['Python 2.7', 'Python 3.5']

[mgedmin]

The docstring for traceback.format_tb says

"""A shorthand for 'format_list(extract_stack(f, limit))."""

which is incorrect -- it's actually a shorthand for format_list(extract_tb(tb, limit)).

Patch attached.

[python-dev]

New changeset e6ab0cd959a0 by Georg Brandl in branch '2.7':
Closes bpo-16657: fix docstring of traceback.format_tb().
http://hg.python.org/cpython/rev/e6ab0cd959a0

[python-dev]

New changeset dcded8c7af89 by Georg Brandl in branch '3.3':
Closes bpo-16657: fix docstring of traceback.format_tb().
http://hg.python.org/cpython/rev/dcded8c7af89