diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2014-11-29 11:06:41 -0500 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2014-11-29 11:06:41 -0500 |
commit | ad339d46c23f561d771d839ac2c32dc59a6c2254 (patch) | |
tree | 367ffa6e6cc4039f819a26c6e3f217367c0ace14 | |
parent | 494fd347a542ab94112350da49bc91b8b1076578 (diff) | |
download | python-coveragepy-git-ad339d46c23f561d771d839ac2c32dc59a6c2254.tar.gz |
Fix spelling errors in the docs.
-rw-r--r-- | .treerc | 2 | ||||
-rw-r--r-- | CHANGES.txt | 6 | ||||
-rw-r--r-- | doc/branch.rst | 2 | ||||
-rw-r--r-- | doc/changes.rst | 6 | ||||
-rw-r--r-- | doc/cmd.rst | 2 | ||||
-rw-r--r-- | doc/dict.txt | 13 | ||||
-rw-r--r-- | doc/excluding.rst | 2 | ||||
-rw-r--r-- | doc/subprocess.rst | 6 |
8 files changed, 26 insertions, 13 deletions
@@ -12,5 +12,5 @@ ignore = sample_html sample_html_beta *.so *.pyd *.gz *.zip - _build + _build _spell *.egg *.egg-info diff --git a/CHANGES.txt b/CHANGES.txt index 2de251a8..f0f3c7b1 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -295,7 +295,7 @@ Version 3.6b1 --- 28 November 2012 - 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`. +- The pydoc tool can now show documentation for the class `coverage.coverage`. Closes `issue 206`_. - Added a page to the docs about contributing to coverage.py, closing @@ -395,7 +395,7 @@ Version 3.5.2b1 --- 29 April 2012 pragmatic fix for `issue 82`_. - The ``-m`` switch on ``coverage report``, which includes missing line numbers - in the summary report, can now be specifed as ``show_missing`` in the + in the summary report, can now be specified as ``show_missing`` in the config file. Closes `issue 173`_. - When running a module with ``coverage run -m <modulename>``, certain details @@ -445,7 +445,7 @@ Version 3.5.1b1 --- 28 August 2011 - An explicit include directive to measure files in the Python installation wouldn't work because of the standard library exclusion. Now the include - directive takes precendence, and the files will be measured. Fixes + directive takes precedence, and the files will be measured. Fixes `issue 138`_. - The HTML report now handles Unicode characters in Python source files diff --git a/doc/branch.rst b/doc/branch.rst index f6b3ac81..8b585893 100644 --- a/doc/branch.rst +++ b/doc/branch.rst @@ -73,7 +73,7 @@ __ http://ivory.idyll.org/blog Excluding code -------------- -If you have :ref:`excluded code <excluding>`, a condtional will not be counted +If you have :ref:`excluded code <excluding>`, a conditional will not be counted as a branch if one of its choices is excluded:: def only_one_choice(x): diff --git a/doc/changes.rst b/doc/changes.rst index a16c544c..8d55acf5 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -177,7 +177,7 @@ Docs: - 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`. +- The pydoc tool can now show documentation for the class `coverage.coverage`. Closes `issue 206`_. - Added some info to the TODO file, closing `issue 227`_. @@ -332,7 +332,7 @@ Version 3.5.2 --- 4 May 2012 pragmatic fix for `issue 82`_. - The ``-m`` switch on ``coverage report``, which includes missing line numbers - in the summary report, can now be specifed as ``show_missing`` in the + in the summary report, can now be specified as ``show_missing`` in the config file. Closes `issue 173`_. - When running a module with ``coverage run -m <modulename>``, certain details @@ -374,7 +374,7 @@ Version 3.5.1 --- 23 September 2011 - An explicit include directive to measure files in the Python installation wouldn't work because of the standard library exclusion. Now the include - directive takes precendence, and the files will be measured. Fixes + directive takes precedence, and the files will be measured. Fixes `issue 138`_. - The HTML report now handles Unicode characters in Python source files diff --git a/doc/cmd.rst b/doc/cmd.rst index a4657c45..543df629 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -210,7 +210,7 @@ If you are collecting and renaming your own data files, you'll need to name them properly for **combine** to find them. It looks for files named after the data file (defaulting to ".coverage", overridable with COVERAGE_FILE), with a dotted suffix. All such files in the current directory will be combined. -Here are some examples of combinable data files:: +Here are some examples of data files that can be combined:: .coverage.machine1 .coverage.20120807T212300 diff --git a/doc/dict.txt b/doc/dict.txt index ead41ffb..0f76abf4 100644 --- a/doc/dict.txt +++ b/doc/dict.txt @@ -15,6 +15,7 @@ canonicalize canonicalized canonicalizes cmdline +Cobertura codecs colorsys config @@ -25,7 +26,9 @@ cov coveragepy coveragerc covhtml +CPython css +CTracer dict dict's dicts @@ -55,8 +58,11 @@ gevent's github globals greenlet +hotkey +hotkeys html HTML +htmlcov http https importlib @@ -92,15 +98,19 @@ opcodes optparse os outfile +overridable parsable parsers pragma +pragmas pre programmability +programmatically py py's pyc pyexpat +pylint pypy PYTHONPATH pyw @@ -111,6 +121,7 @@ renderer settrace setuptools sitecustomize +sortable stackoverflow stderr stdlib @@ -127,7 +138,9 @@ tokenized tokenizer tokenizes tokenizing +tox traceback +tracebacks tuple tuples txt diff --git a/doc/excluding.rst b/doc/excluding.rst index 31e8e9ba..7affe4e4 100644 --- a/doc/excluding.rst +++ b/doc/excluding.rst @@ -46,7 +46,7 @@ from the list of missing code. Branch coverage --------------- -When measuring :ref:`branch coverage <branch>`, a condtional will not be +When measuring :ref:`branch coverage <branch>`, a conditional will not be counted as a branch if one of its choices is excluded:: def only_one_choice(x): diff --git a/doc/subprocess.rst b/doc/subprocess.rst index 40875f7f..89d241c6 100644 --- a/doc/subprocess.rst +++ b/doc/subprocess.rst @@ -30,7 +30,7 @@ Measuring coverage in sub-processes is a little tricky. When you spawn a sub-process, you are invoking Python to run your program. Usually, to get coverage measurement, you have to use coverage.py to run your program. Your sub-process won't be using coverage.py, so we have to convince Python to use -coverage even when not explicitly invokved. +coverage even when not explicitly invoked. To do that, we'll configure Python to run a little coverage.py code when it starts. That code will look for an environment variable that tells it to start @@ -69,5 +69,5 @@ write it. Note that if you use one of these techniques, you must undo them if you uninstall coverage.py, since you will be trying to import it during Python -startup. Be sure to remove the change when you uninstall coverage.py, or use a -more defensive approach to importing it. +start-up. Be sure to remove the change when you uninstall coverage.py, or use +a more defensive approach to importing it. |