[New-bugs-announce] [issue42038] Tracemalloc's format() doc contradictory

[Lisa Roach]

New submission from Lisa Roach <lisaroach14 at gmail.com>:

Tracemalloc's format documentation (https://docs.python.org/3/library/tracemalloc.html#tracemalloc.Traceback.format) says first:

"Format the traceback as a list of lines with newlines."

then:

"Similar to the traceback.format_tb() function, except that format() does not include newlines."

The first statement is incorrect, tracemalloc does NOT add newlines to the list. I recommend just removing the "with newlines" in the first statement.

----------
assignee: docs at python
components: Documentation
messages: 378636
nosy: docs at python, lisroach
priority: low
severity: normal
status: open
title: Tracemalloc's format() doc contradictory
versions: Python 3.10, Python 3.6, Python 3.7, Python 3.8, Python 3.9

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue42038>
_______________________________________