diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2013-01-05 18:06:28 -0500 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2013-01-05 18:06:28 -0500 |
commit | 8116c28f9f4f6bf3780e358ab43f3af40220bf77 (patch) | |
tree | a017dc4151773f9a236b7b33d86dca5e0e4e81d6 /doc | |
parent | 49d8eb2e62cb72830828956fd7a3e351cdfe85ba (diff) | |
download | python-coveragepy-8116c28f9f4f6bf3780e358ab43f3af40220bf77.tar.gz |
Update docs etc for official version 3.6.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/changes.rst | 105 | ||||
-rw-r--r-- | doc/conf.py | 4 | ||||
-rw-r--r-- | doc/index.rst | 3 | ||||
-rw-r--r-- | doc/install.rst | 5 |
4 files changed, 61 insertions, 56 deletions
diff --git a/doc/changes.rst b/doc/changes.rst index af71f31..576c996 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -24,6 +24,7 @@ Major change history for coverage.py :history: 20120929T093100, updated for 3.5.3 :history: 20121129T060100, updated for 3.6b1. :history: 20121223T180600, updated for 3.6b2. +:history: 20130105T173500, updated for 3.6 These are the major changes for coverage.py. For a more complete change @@ -31,37 +32,60 @@ history, see the `CHANGES.txt`_ file in the source tree. .. _CHANGES.txt: http://bitbucket.org/ned/coveragepy/src/tip/CHANGES.txt -Version 3.6b3 -- 29 December 2012 ---------------------------------- -- Beta 2 broke the nose plugin. It's fixed again, closing `issue 224`_. +Version 3.6 --- 5 January 2013 +------------------------------ -.. _issue 224: https://bitbucket.org/ned/coveragepy/issue/224/36b2-breaks-nosexcover +Features: +- The **report**, **html**, and **xml** commands now accept a ``--fail-under`` + switch that indicates in the exit status whether the coverage percentage was + less than a particular value. Closes `issue 139`_. -Version 3.6b2 -- 23 December 2012 ---------------------------------- +- The reporting functions coverage.report(), coverage.html_report(), and + coverage.xml_report() now all return a float, the total percentage covered + measurement. -- Coverage.py runs on Python 2.3 and 2.4 again. It was broken in 3.6b1. +- The HTML report's title can now be set in the configuration file, with the + ``--title`` switch on the command line, or via the API. + +- Configuration files now support substitution of environment variables, using + syntax like ``${WORD}``. Closes `issue 97`_. + +Packaging: - The C extension is optionally compiled using a different more widely-used technique, taking another stab at fixing `issue 80`_ once and for all. -- Combining data files would create entries for phantom files if used with - ``source`` and path aliases. It no longer does. +- When installing, now in addition to creating a "coverage" command, two new + aliases are also installed. A "coverage2" or "coverage3" command will be + created, depending on whether you are installing in Python 2.x or 3.x. + A "coverage-X.Y" command will also be created corresponding to your specific + version of Python. Closes `issue 111`_. -- ``debug sys`` now shows the configuration file path that was read. +- The coverage.py installer no longer tries to bootstrap setuptools or + Distribute. You must have one of them installed first, as `issue 202`_ + recommended. -- If an oddly-behaved package claims that code came from an empty-string - filename, coverage.py no longer associates it with the directory name, - fixing `issue 221`_. +- The coverage.py kit now includes docs (closing `issue 137`_) and tests. -.. _issue 80: https://bitbucket.org/ned/coveragepy/issue/80/is-there-a-duck-typing-way-to-know-we-cant -.. _issue 221: https://bitbucket.org/ned/coveragepy/issue/221/coveragepy-incompatible-with-pyratemp +Docs: +- Added a page to the docs about :doc:`contributing <contributing>` to + coverage.py, closing `issue 171`_. + +- Added a page to the docs about :doc:`troublesome situations <trouble>`, + closing `issue 226`_. + +- Docstrings for the legacy singleton methods are more helpful. Thanks Marius + Gedminas. Closes `issue 205`_. -Version 3.6b1 -- 28 November 2012 ---------------------------------- +- The pydoc tool can now show docmentation for the class `coverage.coverage`. + Closes `issue 206`_. + +- Added some info to the TODO file, closing `issue 227`_. + +Fixes: - Wildcards in ``include=`` and ``omit=`` arguments were not handled properly in reporting functions, though they were when running. Now they are handled @@ -71,22 +95,17 @@ Version 3.6b1 -- 28 November 2012 in a configuration file, please check carefully that you were not relying on the old broken behavior. -- The **report**, **html**, and **xml** commands now accept a ``--fail-under`` - switch that indicates in the exit status whether the coverage percentage was - less than a particular value. Closes `issue 139`_. - -- The reporting functions coverage.report(), coverage.html_report(), and - coverage.xml_report() now all return a float, the total percentage covered - measurement. +- Embarrassingly, the `[xml] output=` setting in the .coveragerc file simply + didn't work. Now it does. -- The HTML report's title can now be set in the configuration file, with the - ``--title`` switch on the command line, or via the API. +- Combining data files would create entries for phantom files if used with + ``source`` and path aliases. It no longer does. -- Configuration files now support substitution of environment variables, using - syntax like ``${WORD}``. Closes `issue 97`_. +- ``debug sys`` now shows the configuration file path that was read. -- Embarrassingly, the `[xml] output=` setting in the .coveragerc file simply - didn't work. Now it does. +- If an oddly-behaved package claims that code came from an empty-string + filename, coverage.py no longer associates it with the directory name, + fixing `issue 221`_. - The XML report now consistently uses filenames for the filename attribute, rather than sometimes using module names. Fixes `issue 67`_. @@ -98,18 +117,6 @@ Version 3.6b1 -- 28 November 2012 total coverage numbers will generally now be lower if you are measuring branch coverage. -- When installing, now in addition to creating a "coverage" command, two new - aliases are also installed. A "coverage2" or "coverage3" command will be - created, depending on whether you are installing in Python 2.x or 3.x. - A "coverage-X.Y" command will also be created corresponding to your specific - version of Python. Closes `issue 111`_. - -- The coverage.py installer no longer tries to bootstrap setuptools or - Distribute. You must have one of them installed first, as `issue 202`_ - recommended. - -- The coverage.py kit now includes docs (closing `issue 137`_) and tests. - - On Windows, files are now reported in their correct case, fixing `issue 89`_ and `issue 203`_. @@ -137,21 +144,14 @@ Version 3.6b1 -- 28 November 2012 fixing `issue 214`_, though this will take some time to be repackaged by the operating systems. -- Docstrings for the legacy singleton methods are more helpful. Thanks Marius - Gedminas. Closes `issue 205`_. - -- The pydoc tool can now show docmentation for the class `coverage.coverage`. - Closes `issue 206`_. - -- Added a page to the docs about contributing to coverage.py, closing - `issue 171`_. - - When coverage.py ended unsuccessfully, it may have reported odd errors like ``'NoneType' object has no attribute 'isabs'``. It no longer does, so kiss `issue 153`_ goodbye. + .. _issue 60: https://bitbucket.org/ned/coveragepy/issue/60/incorrect-path-to-orphaned-pyc-files .. _issue 67: https://bitbucket.org/ned/coveragepy/issue/67/xml-report-filenames-may-be-generated +.. _issue 80: https://bitbucket.org/ned/coveragepy/issue/80/is-there-a-duck-typing-way-to-know-we-cant .. _issue 82: https://bitbucket.org/ned/coveragepy/issue/82/tokenerror-when-generating-html-report .. _issue 89: https://bitbucket.org/ned/coveragepy/issue/89/on-windows-all-packages-are-reported-in .. _issue 97: https://bitbucket.org/ned/coveragepy/issue/97/allow-environment-variables-to-be @@ -172,6 +172,9 @@ Version 3.6b1 -- 28 November 2012 .. _issue 206: https://bitbucket.org/ned/coveragepy/issue/206/pydoc-coveragecoverage-fails-with-an-error .. _issue 210: https://bitbucket.org/ned/coveragepy/issue/210/if-theres-no-coverage-data-coverage-xml .. _issue 214: https://bitbucket.org/ned/coveragepy/issue/214/coveragepy-measures-itself-on-precise +.. _issue 221: https://bitbucket.org/ned/coveragepy/issue/221/coveragepy-incompatible-with-pyratemp +.. _issue 226: https://bitbucket.org/ned/coveragepy/issue/226/make-readme-section-to-describe-when +.. _issue 227: https://bitbucket.org/ned/coveragepy/issue/227/update-todo Version 3.5.3 --- 29 September 2012 diff --git a/doc/conf.py b/doc/conf.py index a7f67a0..e8cd64c 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -40,7 +40,7 @@ master_doc = 'index' # General information about the project. project = u'coverage.py' -copyright = u'2009-2012, Ned Batchelder' +copyright = u'2009\N{EN DASH}2013, Ned Batchelder' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -49,7 +49,7 @@ copyright = u'2009-2012, Ned Batchelder' # The short X.Y version. version = '3.6' # The full version, including alpha/beta/rc tags. -release = '3.6b3' +release = '3.6' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/doc/index.rst b/doc/index.rst index 9e392ba..ed163b8 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -28,6 +28,7 @@ coverage.py :history: 20121128T203700, Updated for 3.6b1. :history: 20121223T180600, Updated for 3.6b2. :history: 20121229T112300, Updated for 3.6b3. +:history: 20130105T174000, Updated for 3.6 Coverage.py is a tool for measuring code coverage of Python programs. It @@ -40,7 +41,7 @@ not. .. ifconfig:: not prerelease - The latest version is coverage.py 3.5.3, released 29 September 2012. + The latest version is coverage.py 3.6, released 5 January 2013. It is supported on Python versions 2.3 through 3.3, and PyPy 1.8. .. ifconfig:: prerelease diff --git a/doc/install.rst b/doc/install.rst index a4e91ac..9539093 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -17,6 +17,7 @@ Installation :history: 20121128T203000, updated for 3.6b1. :history: 20121223T180800, updated for 3.6b2. :history: 20121229T112400, updated for 3.6b3. +:history: 20130105T174400, updated for 3.6. .. highlight:: console @@ -71,9 +72,9 @@ If all went well, you should be able to open a command prompt, and see coverage installed properly:: $ coverage --version - Coverage.py, version 3.6b3. http://nedbatchelder.com/code/coverage/3.6b3 + Coverage.py, version 3.6. http://nedbatchelder.com/code/coverage You can also invoke coverage as a module:: $ python -m coverage --version - Coverage.py, version 3.6b3. http://nedbatchelder.com/code/coverage/3.6b3 + Coverage.py, version 3.6. http://nedbatchelder.com/code/coverage |