This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Incorrect function documentation of _get_object_traceback and _get_traces in _tracemalloc module
Type: Stage: resolved
Components: Documentation, Extension Modules Versions: Python 3.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, georg.brandl, python-dev, vajrasky, vstinner
Priority: normal Keywords: patch

Created on 2013-11-25 04:41 by vajrasky, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
fix_doc__tracemalloc.patch vajrasky, 2013-11-25 04:41 review
Messages (3)
msg204293 - (view) Author: Vajrasky Kok (vajrasky) * Date: 2013-11-25 04:41
>>> import _tracemalloc
>>> _tracemalloc._get_object_traceback.__doc__
'get_object_traceback(obj)\n\nGet the traceback where the Python object obj was allocated.\nReturn a tuple of (filename: str, lineno: int) tuples.\n\nReturn None if the tracemalloc module is disabled or did not\ntrace the allocation of the object.'
>>> _tracemalloc._get_traces.__doc__
'get_traces() -> list\n\nGet traces of all memory blocks allocated by Python.\nReturn a list of (size: int, traceback: tuple) tuples.\ntraceback is a tuple of (filename: str, lineno: int) tuples.\n\nReturn an empty list if the tracemalloc module is disabled.'
msg204299 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2013-11-25 06:57
LGTM.
msg204311 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-11-25 08:34
New changeset 2e2ec595dc58 by Victor Stinner in branch 'default':
Close #19762: Fix name of _get_traces() and _get_object_traceback() function
http://hg.python.org/cpython/rev/2e2ec595dc58
History
Date User Action Args
2022-04-11 14:57:54adminsetgithub: 63961
2013-11-25 08:34:46python-devsetstatus: open -> closed

nosy: + python-dev
messages: + msg204311

resolution: fixed
stage: resolved
2013-11-25 06:57:03georg.brandlsetnosy: + georg.brandl
messages: + msg204299
2013-11-25 04:41:17vajraskycreate