classification
Title: Tracemalloc's format() doc contradictory
Type: Stage:
Components: Documentation Versions: Python 3.10, Python 3.9, Python 3.8, Python 3.7, Python 3.6
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, lisroach
Priority: low Keywords: easy, newcomer friendly

Created on 2020-10-14 17:09 by lisroach, last changed 2020-10-14 17:10 by lisroach.

Messages (1)
msg378636 - (view) Author: Lisa Roach (lisroach) * (Python committer) Date: 2020-10-14 17:09
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.
History
Date User Action Args
2020-10-14 17:10:13lisroachsetkeywords: + easy, newcomer friendly
2020-10-14 17:09:06lisroachcreate