[docs] [issue9264] trace.py documentation is incomplete

Eli Bendersky report at bugs.python.org
Thu Jul 15 06:11:25 CEST 2010

New submission from Eli Bendersky <eliben at gmail.com>:

The documentation of the standard 'trace' module (Doc/library/trace.rst) is sorely lacking. Arguments are not explained, some key methods are not documented at all, and the CoverageResults class isn't documented.

Usage of these appears in the example but leaves the user confused as the only source of documentation for the example is the source code of the module.

I'm attaching a patch that fixes this issue, by providing documentation for the missing parts.

The patch was generated vs. the latest SVN trunk.

assignee: docs at python
components: Documentation
files: tracedoc.3.patch
keywords: patch
messages: 110344
nosy: docs at python, eli.bendersky, tjreedy
priority: normal
severity: normal
status: open
title: trace.py documentation is incomplete
type: behavior
versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2
Added file: http://bugs.python.org/file18009/tracedoc.3.patch

Python tracker <report at bugs.python.org>

More information about the docs mailing list