diff options
author | Ned Batchelder <ned@nedbatchelder.com> | 2015-08-20 13:44:11 -0400 |
---|---|---|
committer | Ned Batchelder <ned@nedbatchelder.com> | 2015-08-20 13:44:11 -0400 |
commit | d5a89ab843542f88544a0f55900093329ef6b85c (patch) | |
tree | 096e088a8193c4d3ecd96755f9f35793d2a0bb76 /doc | |
parent | 33d7789e8e6c15aae52cf3e36eecbd48f36e248e (diff) | |
download | python-coveragepy-git-d5a89ab843542f88544a0f55900093329ef6b85c.tar.gz |
Fix 'filename' to be 'file name' in English.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/changes.rst | 8 | ||||
-rw-r--r-- | doc/cmd.rst | 8 | ||||
-rw-r--r-- | doc/config.rst | 8 | ||||
-rw-r--r-- | doc/python-coverage.1.txt | 2 | ||||
-rw-r--r-- | doc/source.rst | 18 |
5 files changed, 22 insertions, 22 deletions
diff --git a/doc/changes.rst b/doc/changes.rst index 76533259..bf044931 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -379,10 +379,10 @@ Fixes: - ``debug sys`` now shows the configuration file path that was read. - If an oddly-behaved package claims that code came from an empty-string - filename, coverage.py no longer associates it with the directory name, + file name, coverage.py no longer associates it with the directory name, fixing `issue 221`_. -- The XML report now consistently uses filenames for the filename attribute, +- The XML report now consistently uses file names for the filename attribute, rather than sometimes using module names. Fixes `issue 67`_. Thanks, Marcus Cobden. @@ -505,7 +505,7 @@ Version 3.5.2 --- 4 May 2012 option, fixing `issue 168`_. - If a file doesn't parse properly as Python, we don't report it as an error - if the filename seems like maybe it wasn't meant to be Python. This is a + if the file name seems like maybe it wasn't meant to be Python. This is a pragmatic fix for `issue 82`_. - The ``-m`` switch on ``coverage report``, which includes missing line numbers @@ -649,7 +649,7 @@ Controlling source: file patterns rather than file prefixes, closing `issue 34`_ and `issue 36`_. - BACKWARD INCOMPATIBILITY: the `omit_prefixes` argument is gone throughout - coverage.py, replaced with `omit`, a list of filename patterns suitable for + coverage.py, replaced with `omit`, a list of file name patterns suitable for `fnmatch`. A parallel argument `include` controls what files are included. - The run command now has a ``--source`` switch, a list of directories or diff --git a/doc/cmd.rst b/doc/cmd.rst index 83acb888..1070dc0a 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -82,7 +82,7 @@ command:: Your program runs just as if it had been invoked with the Python command line. Arguments after your file name are passed to your program as usual in -``sys.argv``. Rather than providing a filename, you can use the ``-m`` switch +``sys.argv``. Rather than providing a file name, you can use the ``-m`` switch and specify an importable module name instead, just as you can with the Python ``-m`` switch:: @@ -232,9 +232,9 @@ Coverage.py provides a few styles of reporting, with the **report**, **html**, The command-line arguments are module or file names to report on, if you'd like to report on a subset of the data collected. -The ``--include`` and ``--omit`` flags specify lists of filename patterns. They -control which files to report on, and are described in more detail -in :ref:`source`. +The ``--include`` and ``--omit`` flags specify lists of file name patterns. +They control which files to report on, and are described in more detail in +:ref:`source`. The ``-i`` or ``--ignore-errors`` switch tells coverage.py to ignore problems encountered trying to find source files to report on. This can be useful if diff --git a/doc/config.rst b/doc/config.rst index 85e15331..1b451b30 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -124,14 +124,14 @@ for storing or reporting coverage. ``debug`` (multi-string): a list of debug options. See :ref:`the run --debug option <cmd_run_debug>` for details. -``include`` (multi-string): a list of filename patterns, the files to include +``include`` (multi-string): a list of file name patterns, the files to include in measurement or reporting. See :ref:`source` for details. ``note`` (string): an arbitrary string that will be written to the data file. You can use the :meth:`CoverageData.run_infos` method to retrieve this string from a data file. -``omit`` (multi-string): a list of filename patterns, the files to leave out +``omit`` (multi-string): a list of file name patterns, the files to leave out of measurement or reporting. See :ref:`source` for details. ``parallel`` (boolean, default False): append the machine name, process @@ -194,10 +194,10 @@ measurement is under this value, then exit with a status code of 2. ``ignore_errors`` (boolean, default False): ignore source code that can't be found. -``include`` (multi-string): a list of filename patterns, the files to include +``include`` (multi-string): a list of file name patterns, the files to include in reporting. See :ref:`source` for details. -``omit`` (multi-string): a list of filename patterns, the files to leave out +``omit`` (multi-string): a list of file name patterns, the files to leave out of reporting. See :ref:`source` for details. ``partial_branches`` (multi-string): a list of regular expressions. Any line diff --git a/doc/python-coverage.1.txt b/doc/python-coverage.1.txt index 5fe22290..0051f1bf 100644 --- a/doc/python-coverage.1.txt +++ b/doc/python-coverage.1.txt @@ -72,7 +72,7 @@ GLOBAL OPTIONS Specify configuration file `RCFILE`. Defaults to ``.coveragerc``. **--omit** `PATTERN` [ , ... ] - Omit files when their filename matches one of these PATTERNs. + Omit files when their file name matches one of these PATTERNs. Usually needs quoting on the command line. **--include** `PATTERN` [ , ... ] diff --git a/doc/source.rst b/doc/source.rst index b8dcb7be..fb75a6e9 100644 --- a/doc/source.rst +++ b/doc/source.rst @@ -40,14 +40,14 @@ considered, and files with unusual punctuation in their names will be skipped You can further fine-tune coverage.py's attention with the ``--include`` and ``--omit`` switches (or ``[run] include`` and ``[run] omit`` configuration -values). ``--include`` is a list of filename patterns. If specified, only files -matching those patterns will be measured. ``--omit`` is also a list of filename -patterns, specifying files not to measure. If both ``include`` and ``omit`` -are specified, first the set of files is reduced to only those that match the -include patterns, then any files that match the omit pattern are removed from -the set. - -The ``include`` and ``omit`` filename patterns follow typical shell syntax: +values). ``--include`` is a list of file name patterns. If specified, only +files matching those patterns will be measured. ``--omit`` is also a list of +file name patterns, specifying files not to measure. If both ``include`` and +``omit`` are specified, first the set of files is reduced to only those that +match the include patterns, then any files that match the omit pattern are +removed from the set. + +The ``include`` and ``omit`` file name patterns follow typical shell syntax: ``*`` matches any number of characters and ``?`` matches a single character. Patterns that start with a wildcard character are used as-is, other patterns are interpreted relative to the current directory. @@ -69,7 +69,7 @@ parts. The report commands (``report``, ``html``, ``annotate``, and ``xml``) all take optional ``modules`` arguments, and ``--include`` and ``--omit`` switches. The ``modules`` arguments specify particular modules to report on. The ``include`` -and ``omit`` values are lists of filename patterns, just as with the ``run`` +and ``omit`` values are lists of file name patterns, just as with the ``run`` command. Remember that the reporting commands can only report on the data that has been |