Use nested method directives, rewrap long lines, fix whitespace.

merwok · merwok · commit 67f0b6c5f29e · 2010-12-15T19:30:15.000Z
diff --git a/Doc/library/trace.rst b/Doc/library/trace.rst
@@ -25,8 +25,8 @@ simple as ::
 
    python -m trace --count -C . somefile.py ...
 
-The above will execute :file:`somefile.py` and generate annotated listings of all
-Python modules imported during the execution into the current directory.
+The above will execute :file:`somefile.py` and generate annotated listings of
+all Python modules imported during the execution into the current directory.
 
 .. program:: trace
 
@@ -41,19 +41,19 @@ Python modules imported during the execution into the current directory.
 Main options
 ^^^^^^^^^^^^
 
-At least one of the following options must be specified when invoking :mod:`trace`.
-The :option:`--listfuncs <-l>` option is mutually exclusive with the
-:option:`--trace <-t>` and :option:`--counts <-c>` options . When :option:`--listfuncs <-l>`
-is provided, neither :option:`--counts <-c>` nor :option:`--trace <-t>` are accepted,
-and vice versa.
+At least one of the following options must be specified when invoking
+:mod:`trace`.  The :option:`--listfuncs <-l>` option is mutually exclusive with
+the :option:`--trace <-t>` and :option:`--counts <-c>` options . When
+:option:`--listfuncs <-l>` is provided, neither :option:`--counts <-c>` nor
+:option:`--trace <-t>` are accepted, and vice versa.
 
 .. program:: trace
 
 .. cmdoption:: -c, --count
 
    Produce a set of annotated listing files upon program completion that shows
-   how many times each statement was executed.
-   See also :option:`--coverdir <-C>`, :option:`--file <-f>`,
+   how many times each statement was executed.  See also
+   :option:`--coverdir <-C>`, :option:`--file <-f>` and
    :option:`--no-report <-R>` below.
 
 .. cmdoption:: -t, --trace
@@ -67,7 +67,8 @@ and vice versa.
 .. cmdoption:: -r, --report
 
    Produce an annotated list from an earlier program run that used the
-   :option:`--count <-c>` and :option:`--file <-f>` option. Do not execute any code.
+   :option:`--count <-c>` and :option:`--file <-f>` option.  This does not
+   execute any code.
 
 .. cmdoption:: -T, --trackcalls
 
@@ -80,12 +81,12 @@ Modifiers
 
 .. cmdoption:: -f, --file=<file>
 
-   Name of a file to accumulate counts over several tracing runs. Should be used
-   with the :option:`--count <-c>` option.
+   Name of a file to accumulate counts over several tracing runs.  Should be
+   used with the :option:`--count <-c>` option.
 
 .. cmdoption:: -C, --coverdir=<dir>
 
-   Directory where the report files go. The coverage report for
+   Directory where the report files go.  The coverage report for
    ``package.module`` is written to file :file:`{dir}/{package}/{module}.cover`.
 
 .. cmdoption:: -m, --missing
@@ -106,7 +107,7 @@ Modifiers
 
 .. cmdoption:: -g, --timing
 
-   Prefix each line with the time since the program started. Only used while
+   Prefix each line with the time since the program started.  Only used while
    tracing.
 
 Filters
@@ -118,8 +119,8 @@ These options may be repeated multiple times.
 
 .. cmdoption:: --ignore-module=<mod>
 
-   Ignore each of the given module names and its submodules (if it is a package).
-   The argument can be a list of names separated by a comma.
+   Ignore each of the given module names and its submodules (if it is a
+   package).  The argument can be a list of names separated by a comma.
 
 .. cmdoption:: --ignore-dir=<dir>
 
@@ -131,56 +132,61 @@ These options may be repeated multiple times.
 Programmatic Interface
 ----------------------
 
-.. class:: Trace(count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(), ignoredirs=(), infile=None, outfile=None, timing=False)
+.. class:: Trace(count=1, trace=1, countfuncs=0, countcallers=0, ignoremods=(),\
+                 ignoredirs=(), infile=None, outfile=None, timing=False)
 
-   Create an object to trace execution of a single statement or expression. All
-   parameters are optional.  *count* enables counting of line numbers. *trace*
-   enables line execution tracing.  *countfuncs* enables listing of the functions
-   called during the run.  *countcallers* enables call relationship tracking.
-   *ignoremods* is a list of modules or packages to ignore.  *ignoredirs* is a list
-   of directories whose modules or packages should be ignored.  *infile* is the
-   name of the file from which to read stored count information.  *outfile* is
-   the name of the file in which to write updated count information. *timing*
-   enables a timestamp relative to when tracing was started to be displayed.
+   Create an object to trace execution of a single statement or expression.  All
+   parameters are optional.  *count* enables counting of line numbers.  *trace*
+   enables line execution tracing.  *countfuncs* enables listing of the
+   functions called during the run.  *countcallers* enables call relationship
+   tracking.  *ignoremods* is a list of modules or packages to ignore.
+   *ignoredirs* is a list of directories whose modules or packages should be
+   ignored.  *infile* is the name of the file from which to read stored count
+   information.  *outfile* is the name of the file in which to write updated
+   count information.  *timing* enables a timestamp relative to when tracing was
+   started to be displayed.
 
-.. method:: Trace.run(cmd)
+    .. method:: run(cmd)
 
-   Execute the command and gather statistics from the execution with
-   the current tracing parameters.
-   *cmd* must be a string or code object, suitable for passing into :func:`exec`.
+       Execute the command and gather statistics from the execution with
+       the current tracing parameters.  *cmd* must be a string or code object,
+       suitable for passing into :func:`exec`.
 
-.. method:: Trace.runctx(cmd, globals=None, locals=None)
+    .. method:: runctx(cmd, globals=None, locals=None)
 
-   Execute the command and gather statistics from the execution with
-   the current tracing parameters, in the defined global and local environments.
-   If not defined, *globals* and *locals* default to empty dictionaries.
+       Execute the command and gather statistics from the execution with the
+       current tracing parameters, in the defined global and local
+       environments.  If not defined, *globals* and *locals* default to empty
+       dictionaries.
 
-.. method:: Trace.runfunc(func, *args, **kwds)
+    .. method:: runfunc(func, *args, **kwds)
 
-   Call *func* with the given arguments under control of the :class:`Trace` object
-   with the current tracing parameters.
+       Call *func* with the given arguments under control of the :class:`Trace`
+       object with the current tracing parameters.
 
-.. method:: Trace.results()
+    .. method:: results()
 
-   Return a :class:`CoverageResults` object that contains the cumulative results
-   of all previous calls to ``run``, ``runctx`` and ``runfunc`` for the given
-   :class:`Trace` instance. Does not reset the accumulated trace results.
+       Return a :class:`CoverageResults` object that contains the cumulative
+       results of all previous calls to ``run``, ``runctx`` and ``runfunc``
+       for the given :class:`Trace` instance.  Does not reset the accumulated
+       trace results.
 
 .. class:: CoverageResults
 
-   A container for coverage results, created by :meth:`Trace.results`. Should not
-   be created directly by the user.
+   A container for coverage results, created by :meth:`Trace.results`.  Should
+   not be created directly by the user.
 
-.. method:: CoverageResults.update(other)
+    .. method:: update(other)
 
-   Merge in data from another :class:`CoverageResults` object.
+       Merge in data from another :class:`CoverageResults` object.
 
-.. method:: CoverageResults.write_results(show_missing=True, summary=False, coverdir=None)
+    .. method:: write_results(show_missing=True, summary=False, coverdir=None)
 
-   Write coverage results. Set *show_missing* to show lines that had no hits.
-   Set *summary* to include in the output the coverage summary per module. *coverdir*
-   specifies the directory into which the coverage result files will be output.
-   If ``None``, the results for each source file are placed in its directory.
+       Write coverage results.  Set *show_missing* to show lines that had no
+       hits.  Set *summary* to include in the output the coverage summary per
+       module.  *coverdir* specifies the directory into which the coverage
+       result files will be output.  If ``None``, the results for each source
+       file are placed in its directory.
 
 A simple example demonstrating the use of the programmatic interface::
 
