diff options
| -rw-r--r-- | CHANGES.rst | 15 | ||||
| -rw-r--r-- | doc/changes.rst | 20 | ||||
| -rw-r--r-- | doc/cmd.rst | 2 | ||||
| -rw-r--r-- | doc/config.rst | 3 | ||||
| -rw-r--r-- | doc/faq.rst | 6 | ||||
| -rw-r--r-- | doc/howitworks.rst | 6 | ||||
| -rw-r--r-- | doc/plugins.rst | 4 | ||||
| -rw-r--r-- | doc/requirements.pip | 1 | ||||
| -rw-r--r-- | tox.ini | 1 |
9 files changed, 32 insertions, 26 deletions
diff --git a/CHANGES.rst b/CHANGES.rst index e67e820c..e2f656dd 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -522,8 +522,9 @@ Version 4.0a6 --- 2015-06-21 persisted in pursuing this despite Ned's pessimism. Fixes `issue 308`_ and `issue 324`_. -- The COVERAGE_DEBUG environment variable can be used to set the ``[run] debug`` - configuration option to control what internal operations are logged. +- The COVERAGE_DEBUG environment variable can be used to set the + ``[run] debug`` configuration option to control what internal operations are + logged. - HTML reports were truncated at formfeed characters. This is now fixed (`issue 360`_). It's always fun when the problem is due to a `bug in the @@ -1144,9 +1145,9 @@ Version 3.5b1 --- 2011-06-05 - Partial branch warnings can now be pragma'd away. The configuration option ``partial_branches`` is a list of regular expressions. Lines matching any of those expressions will never be marked as a partial branch. In addition, - there's a built-in list of regular expressions marking statements which should - never be marked as partial. This list includes ``while True:``, ``while 1:``, - ``if 1:``, and ``if 0:``. + there's a built-in list of regular expressions marking statements which + should never be marked as partial. This list includes ``while True:``, + ``while 1:``, ``if 1:``, and ``if 0:``. - The ``coverage()`` constructor accepts single strings for the ``omit=`` and ``include=`` arguments, adapting to a common error in programmatic use. @@ -1635,8 +1636,8 @@ Version 2.78 --- 2007-09-30 --------------------------- - Don't try to predict whether a file is Python source based on the extension. - Extension-less files are often Pythons scripts. Instead, simply parse the file - and catch the syntax errors. Hat tip to Ben Finney. + Extension-less files are often Pythons scripts. Instead, simply parse the + file and catch the syntax errors. Hat tip to Ben Finney. Version 2.77 --- 2007-07-29 diff --git a/doc/changes.rst b/doc/changes.rst index 6cd3ab61..c75b2ba8 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -391,10 +391,11 @@ New features: index page, and only modules with that text in the name will be shown. Thanks, Danny Allen. -- A new option: ``coverage report --skip-covered`` (or ``[report] skip_covered``) - will reduce the number of files reported by skipping files with 100% - coverage. Thanks, Krystian Kichewko. This means that empty ``__init__.py`` - files will be skipped, since they are 100% covered. +- A new option: ``coverage report --skip-covered`` + (or ``[report] skip_covered``) will reduce the number of files reported by + skipping files with 100% coverage. Thanks, Krystian Kichewko. This means + that empty ``__init__.py`` files will be skipped, since they are 100% + covered. - You can now specify the ``--fail-under`` option in the ``.coveragerc`` file as the ``[report] fail_under`` option. @@ -417,8 +418,9 @@ New features: stored in the ``runs`` section of the data file. You can use this to annotate the data file with any information you like. -- The COVERAGE_DEBUG environment variable can be used to set the ``[run] debug`` - configuration option to control what internal operations are logged. +- The COVERAGE_DEBUG environment variable can be used to set the + ``[run] debug`` configuration option to control what internal operations are + logged. - A new version identifier is available, `coverage.version_info`, a plain tuple of values similar to `sys.version_info`_. @@ -913,9 +915,9 @@ Reporting - Partial branch warnings can now be pragma'd away. The configuration option ``partial_branches`` is a list of regular expressions. Lines matching any of those expressions will never be marked as a partial branch. In addition, - there's a built-in list of regular expressions marking statements which should - never be marked as partial. This list includes ``while True:``, ``while 1:``, - ``if 1:``, and ``if 0:``. + there's a built-in list of regular expressions marking statements which + should never be marked as partial. This list includes ``while True:``, + ``while 1:``, ``if 1:``, and ``if 0:``. - The ``--omit`` and ``--include`` switches now interpret their values more usefully. If the value starts with a wildcard character, it is used as-is. diff --git a/doc/cmd.rst b/doc/cmd.rst index 471e91c1..6ca1fc42 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -16,7 +16,7 @@ Coverage.py command line usage .. :history: 20100725T211700, updated for 3.4 .. :history: 20110827T212500, updated for 3.5.1, combining aliases .. :history: 20120119T075600, Added some clarification from George Paci -.. :history: 20120504T091800, Added info about execution warnings, and 3.5.2 stuff. +.. :history: 20120504T091800, Added info about execution warnings, and 3.5.2. .. :history: 20120807T211600, Clarified the combine rules. .. :history: 20121003T074600, Fixed an option reference, https://bitbucket.org/ned/coveragepy/issue/200/documentation-mentions-output-xml-instead .. :history: 20121117T091000, Added command aliases. diff --git a/doc/config.rst b/doc/config.rst index b149f4f6..afa67570 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -232,7 +232,8 @@ Allowed values are "Name", "Stmts", "Miss", "Branch", "BrPart", or "Cover". Values particular to HTML reporting. The values in the ``[report]`` section also apply to HTML output, where appropriate. -``directory`` (string, default "htmlcov"): where to write the HTML report files. +``directory`` (string, default "htmlcov"): where to write the HTML report +files. ``extra_css`` (string): the path to a file of CSS to apply to the HTML report. The file will be copied into the HTML output directory. Don't name it diff --git a/doc/faq.rst b/doc/faq.rst index d10e14dd..11261f7d 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -58,9 +58,9 @@ coverage.start() before importing the modules that define your functions. Make sure you are using the C trace function. Coverage.py provides two implementations of the trace function. The C implementation runs much faster. To see what you are running, use ``coverage debug sys``. The output contains -details of the environment, including a line that says either ``tracer: CTracer`` -or ``tracer: PyTracer``. If it says ``PyTracer`` then you are using the -slow Python implementation. +details of the environment, including a line that says either +``tracer: CTracer`` or ``tracer: PyTracer``. If it says ``PyTracer`` then you +are using the slow Python implementation. Try re-installing coverage.py to see what happened and if you get the CTracer as you should. diff --git a/doc/howitworks.rst b/doc/howitworks.rst index 6253f44a..7c200923 100644 --- a/doc/howitworks.rst +++ b/doc/howitworks.rst @@ -33,9 +33,9 @@ Execution --------- At the heart of the execution phase is a Python trace function. This is a -function that the Python interpreter invokes for each line executed in a program. -Coverage.py implements a trace function that records each file and line number -as it is executed. +function that the Python interpreter invokes for each line executed in a +program. Coverage.py implements a trace function that records each file and +line number as it is executed. Executing a function for every line in your program can make execution very slow. Coverage.py's trace function is implemented in C to reduce that diff --git a/doc/plugins.rst b/doc/plugins.rst index 3e7cee09..2d7fc278 100644 --- a/doc/plugins.rst +++ b/doc/plugins.rst @@ -28,8 +28,8 @@ Using plugins ------------- To use a coverage.py plugin, you install it, and configure it. For this -example, let's say there's a Python package called ``something`` that provides a -coverage.py plugin called ``something.plugin``. +example, let's say there's a Python package called ``something`` that provides +a coverage.py plugin called ``something.plugin``. #. Install the plugin's package as you would any other Python package:: diff --git a/doc/requirements.pip b/doc/requirements.pip index 13426812..3a8f6254 100644 --- a/doc/requirements.pip +++ b/doc/requirements.pip @@ -2,6 +2,7 @@ # https://requires.io/github/nedbat/coveragepy/requirements/ +doc8==0.7.0 pyenchant==1.6.7 sphinx==1.4.5 sphinxcontrib-spelling==2.2.0 @@ -74,6 +74,7 @@ basepython = pypy3-5.2 # return. deps = -rdoc/requirements.pip commands = + doc8 doc CHANGES.rst README.rst sphinx-build -b html -b linkcheck -aEnq doc doc/_build/html sphinx-build -b html -b linkcheck -aEnQW doc doc/_build/html rst2html.py --strict CHANGES.rst doc/_build/trash |