diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2009-05-28 21:04:54 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2009-05-28 21:04:54 -0400 |
| commit | 50ce8b99a5ef63f473083ed7cea48dc503258da0 (patch) | |
| tree | 8b3f03b714adf78bbb5ee2c7ffdb1a025d6532eb | |
| parent | b42985e17c3ae2071939c451d9a82865ca53608d (diff) | |
| download | python-coveragepy-git-50ce8b99a5ef63f473083ed7cea48dc503258da0.tar.gz | |
Slow progress on docs.
| -rw-r--r-- | doc/api.rst | 13 | ||||
| -rw-r--r-- | doc/changes.rst | 60 | ||||
| -rw-r--r-- | doc/cmd.rst | 9 | ||||
| -rw-r--r-- | doc/index.rst | 38 |
4 files changed, 93 insertions, 27 deletions
diff --git a/doc/api.rst b/doc/api.rst index 279e9dbb..951ddb42 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -4,15 +4,12 @@ Coverage API ============ -The API to coverage.py is very simple, contained in a single module called -coverage containing a single class, also called coverage:: - - import coverage +:history: 20090524T134300, brand new docs. - cov = coverage.coverage() - -Methods on the coverage object correspond to operations available in the -command line interface. For example, a simple use would be:: +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:: import coverage diff --git a/doc/changes.rst b/doc/changes.rst new file mode 100644 index 00000000..d7c0d735 --- /dev/null +++ b/doc/changes.rst @@ -0,0 +1,60 @@ +.. _change:
+
+:history: 20090524T134300, brand new docs.
+
+------------------------------------
+Major change history for coverage.py
+------------------------------------
+
+These are the major changes for coverage.py. For a more complete change history,
+see the `CHANGES.txt <http://bitbucket.org/ned/coveragepy/src/tip/CHANGES.txt>`_
+file.
+
+Version 3.0b3, 16 May 2009
+--------------------------
+
+- Added parameters to coverage.__init__ for options that had been set on the
+ coverage object itself.
+
+- Added clear_exclude() and get_exclude_list() methods for programmatic
+ manipulation of the exclude regexes.
+
+- Added coverage.load() to read previously-saved data from the data file.
+
+- When using the object api (that is, constructing a coverage() object), data
+ is no longer saved automatically on process exit. You can re-enable it with
+ the auto_data=True parameter on the coverage() constructor. The module-level
+ interface still uses automatic saving.
+
+
+Version 3.0b2, 30 April 2009
+----------------------------
+
+HTML reporting, and continued refactoring.
+
+- HTML reports and annotation of source files: use the new -b (browser) switch.
+ Thanks to George Song for code, inspiration and guidance.
+
+- Code in the Python standard library is not measured by default. If you need
+ to measure standard library code, use the -L command-line switch during
+ execution, or the cover_pylib=True argument to the coverage() constructor.
+
+- coverage.annotate_file is no longer available.
+
+- Removed the undocumented cache_file argument to coverage.usecache().
+
+
+Version 3.0b1, 7 March 2009
+---------------------------
+
+Major overhaul.
+
+- Coverage is now a package rather than a module. Functionality has been split
+ into classes.
+
+- The trace function is implemented in C for speed. Coverage runs are now
+ much faster. Thanks to David Christian for productive micro-sprints and
+ other encouragement.
+
+- The minimum supported Python version is 2.3.
+
diff --git a/doc/cmd.rst b/doc/cmd.rst index 1936e37f..4d49e3f0 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -1,10 +1,13 @@ .. _cmd: -.. highlight:: console =========================== -Coverage Command Line usage +Coverage command line usage =========================== +:history: 20090524T134300, brand new docs. + +.. highlight:: console + When you install coverage, a command-line script called coverage is placed in the Python scripts directory. Coverage performs a number of actions, determined by the flags on the command line: @@ -123,6 +126,8 @@ and which were not. The -b flag creates an HTML report similar to the -r summary, but as an HTML file. Each module name links to the source file decorated to show the status of each line. +Here's a `sample report </code/coverage/sample_html/index.html>`_. + Annotation ---------- diff --git a/doc/index.rst b/doc/index.rst index 87098326..48c56c55 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,23 +3,6 @@ coverage.py ===========
:history: 20090524T134300, brand new docs.
-:history: 20090524T134301, tweaked.
-
-.. toctree::
- :hidden:
-
- cmd
- api
-
-
-.. FAQ
-.. Why do unexecutable lines show up as executed?
-.. Why do the bodies of fns show as executed, but the def lines do not?
-.. Change History
-.. Getting Help
-.. How it works
-.. .coverage file format
-.. Excluding lines
Coverage.py is a tool for measuring code coverage of Python programs. It monitors
your program, noting which parts of the code have been executed, then analyzes the
@@ -69,3 +52,24 @@ Using coverage.py There are two supported interfaces to coverage: a :ref:`command line <cmd>` and
an :ref:`API <api>`.
+
+
+More information
+----------------
+
+.. toctree::
+ :maxdepth: 1
+
+ cmd
+ api
+ changes
+
+
+.. FAQ
+.. Why do unexecutable lines show up as executed?
+.. Why do the bodies of fns show as executed, but the def lines do not?
+.. Change History
+.. Getting Help
+.. How it works
+.. .coverage file format
+.. Excluding lines
|