classification
Title: Small doc improvements for tracemalloc
Type: enhancement Stage:
Components: Documentation Versions: Python 3.4
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, loicp, python-dev, vstinner
Priority: normal Keywords: patch

Created on 2016-12-29 23:39 by loicp, last changed 2016-12-30 01:17 by vstinner. This issue is now closed.

Files
File name Uploaded Description Edit
doc_3.4_tracemalloc.diff loicp, 2016-12-29 23:39 Patch against v3.4.0 review
Messages (3)
msg284298 - (view) Author: Loic Pefferkorn (loicp) Date: 2016-12-29 23:39
Hello,

I believe that some improvements can be made to the Python 3.4 documentation of the tracemalloc module:

* Wrong parameter name, 'group_by' instead of 'key_type' (checked in tracemalloc.py)
* Don't round up numbers when explaining the examples. If they exactly match what can be read in the script output, it is to easier to understand (4.8 MiB vs 4855 KiB)
* Fix incorrect method link that was pointing to another module

I will wait for some feedback before checking the 3.5, 3.6 versions, hopefully I did not forget something :)

Cheers,
Loic
msg284300 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2016-12-30 01:15
New changeset 192e0ae17236 by Victor Stinner in branch '3.5':
Issue #29109: Enhance tracemalloc documentation
https://hg.python.org/cpython/rev/192e0ae17236
msg284301 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2016-12-30 01:17
Thank you for your contribution! I applied your patch to Python 3.5, 3.6 and default (future 3.7).

You should consider signing the PSF Contributor Agreement:
https://www.python.org/psf/contrib/contrib-form/

"While you retain the copyright, giving the PSF the ability to license your code means it can be put under the PSF license so it can be legally distributed with Python."
History
Date User Action Args
2016-12-30 01:17:24vstinnersetstatus: open -> closed
resolution: fixed
messages: + msg284301
2016-12-30 01:15:53python-devsetnosy: + python-dev
messages: + msg284300
2016-12-29 23:39:06loicpcreate