[New-bugs-announce] [issue25573] traceback documentation example is lying about FrameSummary repr()

[Alexandre Macabies]

New submission from Alexandre Macabies:

https://docs.python.org/3.5/library/traceback.html#traceback-examples
See second code sample and its sample output. According to the docs, the call:

  print(repr(traceback.extract_tb(exc_traceback)))

is supposed to print something that looks like an array with only strings; that is what the doc sample output states:

  [('<doctest...>', 10, '<module>', 'lumberjack()'),

But actually, in 3.5+, this call outputs the repr() of a list of FrameSummary instances that do not go further in repr()esenting their state:

  [<FrameSummary file <ipython-input-61-3e63d7daea82>, line 10 in <module>>,

By looking at the docs I thought I was able to get a nice string representation of a FrameSummary. I actually have to format it myself. It should be reflected in the doc sample output.

----------
assignee: docs at python
components: Documentation
messages: 254224
nosy: Alexandre Macabies, docs at python
priority: normal
severity: normal
status: open
title: traceback documentation example is lying about FrameSummary repr()
versions: Python 3.5, Python 3.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue25573>
_______________________________________