From 95b613a9202ec075e68ee0600a880dd8cba26d6c Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Mon, 22 Feb 2010 07:22:52 -0500 Subject: Fiddling with docs for 3.3 --- doc/api.rst | 15 ++++++++++++--- doc/changes.rst | 30 +++++++++++++++++++++++++++++- 2 files changed, 41 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/api.rst b/doc/api.rst index 98187a8f..03cc7607 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -6,11 +6,12 @@ Coverage API :history: 20090524T134300, brand new docs. :history: 20090613T164000, final touches for 3.0 +:history: 20100221T151500, docs for 3.3 (on the plane back from PyCon) The API to coverage.py is very simple, contained in a single module called -coverage containing a single class, also called coverage. Methods on the -coverage object correspond to operations available in the command line -interface. For example, a simple use would be:: +`coverage`. Most of the interface is in a single class, also called +`coverage`. Methods on the coverage object correspond to operations available +in the command line interface. For example, a simple use would be:: import coverage @@ -30,3 +31,11 @@ The coverage module .. autoclass:: coverage :members: + + +Starting coverage automatically +------------------------------- + +This is cool. + +.. autofunction:: process_startup diff --git a/doc/changes.rst b/doc/changes.rst index aef10040..a0a5d278 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -10,7 +10,7 @@ Major change history for coverage.py :history: 20091004T170700, changes for 3.1 :history: 20091128T072200, changes for 3.2 :history: 20091205T161525, 3.2 final - +:history: 20100221T151900, changes for 3.3 These are the major changes for coverage.py. For a more complete change history, see the `CHANGES.txt`_ file in the source tree. @@ -18,6 +18,34 @@ history, see the `CHANGES.txt`_ file in the source tree. .. _CHANGES.txt: http://bitbucket.org/ned/coveragepy/src/tip/CHANGES.txt +Version 3.3 +----------- + +- Settings are now read from a .coveragerc file. A specific file can be + specified on the command line with --rcfile=FILE. The name of the file can + be programmatically set with the `config_file` argument to the coverage() + constructor, or reading a config file can be disabled with + `config_file=False`. + +- Added coverage.process_start to enable coverage measurement when Python + starts. + +- Parallel data file names now have a random number appended to them in + addition to the machine name and process id. Also, parallel data files + combined with "coverage combine" are deleted after they're combined, to clean + up unneeded files. Fixes `issue 40`_. + +- Fixed a problem with nested loops having their branch possibilities + mischaracterized: `issue 39`_. + +- Exceptions thrown from product code run with "coverage run" are now displayed + without internal coverage.py frames, so the output is the same as when the + code is run without coverage.py. + +.. _issue 39: http://bitbucket.org/ned/coveragepy/issue/39 +.. _issue 40: http://bitbucket.org/ned/coveragepy/issue/40 + + Version 3.2, 5 December 2009 ---------------------------- -- cgit v1.2.1