Small doc improvements for tracemalloc

[loicp]

BPO	29109
Nosy	@vstinner
Files	doc_3.4_tracemalloc.diff: Patch against v3.4.0

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2016-12-30.01:17:24.840>
created_at = <Date 2016-12-29.23:39:06.896>
labels = ['type-feature', 'docs']
title = 'Small doc improvements for tracemalloc'
updated_at = <Date 2016-12-30.01:17:24.838>
user = 'https://bugs.python.org/loicp'

bugs.python.org fields:

activity = <Date 2016-12-30.01:17:24.838>
actor = 'vstinner'
assignee = 'docs@python'
closed = True
closed_date = <Date 2016-12-30.01:17:24.840>
closer = 'vstinner'
components = ['Documentation']
creation = <Date 2016-12-29.23:39:06.896>
creator = 'loicp'
dependencies = []
files = ['46086']
hgrepos = []
issue_num = 29109
keywords = ['patch']
message_count = 3.0
messages = ['284298', '284300', '284301']
nosy_count = 4.0
nosy_names = ['vstinner', 'docs@python', 'python-dev', 'loicp']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue29109'
versions = ['Python 3.4']

[loicp]

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

[python-dev]

New changeset 192e0ae17236 by Victor Stinner in branch '3.5':
Issue bpo-29109: Enhance tracemalloc documentation
https://hg.python.org/cpython/rev/192e0ae17236

[vstinner]

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."