Skip to content

Commit aa62abd

Browse files
committed
style: fix spelling
un-executed, white space, time stamp.
1 parent 79c66c0 commit aa62abd

18 files changed

+53
-57
lines changed

CHANGES.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,12 @@ released.)
3939

4040
- Combining data files with ``coverage combine`` now quickly hashes the data
4141
files to skip files that provide no new information. This can reduce the
42-
time needed. Many details affect the results, but for coverage.py's own test
43-
suite, combining was about 40% faster. Closes `issue 1483`_.
42+
time needed. Many details affect the speed-up, but for coverage.py's own
43+
test suite, combining was about 40% faster. Closes `issue 1483`_.
4444

45-
- When searching for completely unexecuted files, coverage.py uses the presence
46-
of ``__init__.py`` files to determine which directories have source that
47-
could have been imported. However, `implicit namespace packages`_ don't
45+
- When searching for completely un-executed files, coverage.py uses the
46+
presence of ``__init__.py`` files to determine which directories have source
47+
that could have been imported. However, `implicit namespace packages`_ don't
4848
require ``__init__.py``. A new setting ``[report]
4949
include_namespace_packages`` tells coverage.py to consider these directories
5050
during reporting. Thanks to `Felix Horvat <pull 1387_>`_ for the
@@ -191,7 +191,7 @@ Version 6.4.2 — 2022-07-12
191191
--------------------------
192192

193193
- Updated for a small change in Python 3.11.0 beta 4: modules now start with a
194-
line with line number 0, which is ignored. This line cannnot be executed, so
194+
line with line number 0, which is ignored. This line cannot be executed, so
195195
coverage totals were thrown off. This line is now ignored by coverage.py,
196196
but this also means that truly empty modules (like ``__init__.py``) have no
197197
lines in them, rather than one phantom line. Fixes `issue 1419`_.
@@ -242,7 +242,7 @@ Version 6.4 — 2022-05-22
242242
``?`` to open/close the help panel. Thanks, `J. M. F. Tsang
243243
<pull 1364_>`_.
244244

245-
- The timestamp and version are displayed at the top of the report. Thanks,
245+
- The time stamp and version are displayed at the top of the report. Thanks,
246246
`Ammar Askar <pull 1354_>`_. Closes `issue 1351`_.
247247

248248
- A new debug option ``debug=sqldata`` adds more detail to ``debug=sql``,
@@ -531,7 +531,7 @@ Version 6.0.2 — 2021-10-11
531531

532532
- Packages named as "source packages" (with ``source``, or ``source_pkgs``, or
533533
pytest-cov's ``--cov``) might have been only partially measured. Their
534-
top-level statements could be marked as unexecuted, because they were
534+
top-level statements could be marked as un-executed, because they were
535535
imported by coverage.py before measurement began (`issue 1232`_). This is
536536
now fixed, but the package will be imported twice, once by coverage.py, then
537537
again by your test suite. This could cause problems if importing the package

coverage/config.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ def getlist(self, section, option):
9393
"""Read a list of strings.
9494
9595
The value of `section` and `option` is treated as a comma- and newline-
96-
separated list of strings. Each value is stripped of whitespace.
96+
separated list of strings. Each value is stripped of white space.
9797
9898
Returns the list of strings.
9999
@@ -111,7 +111,7 @@ def getregexlist(self, section, option):
111111
"""Read a list of full-line regexes.
112112
113113
The value of `section` and `option` is treated as a newline-separated
114-
list of regexes. Each value is stripped of whitespace.
114+
list of regexes. Each value is stripped of white space.
115115
116116
Returns the list of strings.
117117

coverage/control.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -812,7 +812,7 @@ def _post_save_work(self):
812812
"""After saving data, look for warnings, post-work, etc.
813813
814814
Warn about things that should have happened but didn't.
815-
Look for unexecuted files.
815+
Look for un-executed files.
816816
817817
"""
818818
# If there are still entries in the source_pkgs_unmatched list,
@@ -825,7 +825,7 @@ def _post_save_work(self):
825825
self._warn("No data was collected.", slug="no-data-collected")
826826

827827
# Touch all the files that could have executed, so that we can
828-
# mark completely unexecuted files as 0% covered.
828+
# mark completely un-executed files as 0% covered.
829829
if self._data is not None:
830830
file_paths = collections.defaultdict(list)
831831
for file_path, plugin_name in self._inorout.find_possibly_unexecuted_files():

coverage/inorout.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -576,7 +576,7 @@ def _find_executable_files(self, src_dir):
576576
file_path = canonical_filename(file_path)
577577
if self.omit_match and self.omit_match.match(file_path):
578578
# Turns out this file was omitted, so don't pull it back
579-
# in as unexecuted.
579+
# in as un-executed.
580580
continue
581581
yield file_path, plugin_name
582582

coverage/parser.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -177,11 +177,10 @@ def _raw_parse(self):
177177
first_on_line = True
178178

179179
if ttext.strip() and toktype != tokenize.COMMENT:
180-
# A non-whitespace token.
180+
# A non-white-space token.
181181
empty = False
182182
if first_line is None:
183-
# The token is not whitespace, and is the first in a
184-
# statement.
183+
# The token is not white space, and is the first in a statement.
185184
first_line = slineno
186185
# Check whether to end an excluded suite.
187186
if excluding and indent <= exclude_indent:

coverage/phystokens.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ def source_token_lines(source):
9595
9696
If you concatenate all the token texts, and then join them with newlines,
9797
you should have your original `source` back, with two differences:
98-
trailing whitespace is not preserved, and a final line with no newline
98+
trailing white space is not preserved, and a final line with no newline
9999
is indistinguishable from a final line with a newline.
100100
101101
"""

coverage/results.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def arcs_executed(self):
8484

8585
@contract(returns='list(tuple(int, int))')
8686
def arcs_missing(self):
87-
"""Returns a sorted list of the unexecuted arcs in the code."""
87+
"""Returns a sorted list of the un-executed arcs in the code."""
8888
possible = self.arc_possibilities()
8989
executed = self.arcs_executed()
9090
missing = (

coverage/templite.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ class Templite:
9292
and joined. Be careful, this could join words together!
9393
9494
Any of these constructs can have a hyphen at the end (`-}}`, `-%}`, `-#}`),
95-
which will collapse the whitespace following the tag.
95+
which will collapse the white space following the tag.
9696
9797
Construct a Templite with the template text, then use `render` against a
9898
dictionary context to create a finished string::

doc/changes.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ Version 5.0a6 — 2019-07-16
383383
argument, `no_disk` (default: False). Setting it to True prevents writing
384384
any data to the disk. This is useful for transient data objects.
385385

386-
- Added the classmethod :meth:`.Coverage.current` to get the latest started
386+
- Added the class method :meth:`.Coverage.current` to get the latest started
387387
Coverage instance.
388388

389389
- Multiprocessing support in Python 3.8 was broken, but is now fixed. Closes
@@ -556,7 +556,7 @@ Version 5.0a2 — 2018-09-03
556556

557557
- Development moved from `Bitbucket`_ to `GitHub`_.
558558

559-
- HTML files no longer have trailing and extra whitespace.
559+
- HTML files no longer have trailing and extra white space.
560560

561561
- The sort order in the HTML report is stored in local storage rather than
562562
cookies, closing `issue 611`_. Thanks, Federico Bond.
@@ -794,7 +794,7 @@ Version 4.4b1 — 2017-04-04
794794
also continue measurement. Both `issue 79`_ and `issue 448`_ described this
795795
problem, and have been fixed.
796796

797-
- Plugins can now find unexecuted files if they choose, by implementing the
797+
- Plugins can now find un-executed files if they choose, by implementing the
798798
`find_executable_files` method. Thanks, Emil Madsen.
799799

800800
- Minimal IronPython support. You should be able to run IronPython programs
@@ -1202,7 +1202,7 @@ Version 4.1b2 — 2016-01-23
12021202
- The XML report now produces correct package names for modules found in
12031203
directories specified with ``source=``. Fixes `issue 465`_.
12041204

1205-
- ``coverage report`` won't produce trailing whitespace.
1205+
- ``coverage report`` won't produce trailing white space.
12061206

12071207
.. _issue 465: https://github.com/nedbat/coveragepy/issues/465
12081208
.. _issue 466: https://github.com/nedbat/coveragepy/issues/466
@@ -1532,7 +1532,7 @@ Version 4.0a6 — 2015-06-21
15321532
- Files with incorrect encoding declaration comments are no longer ignored by
15331533
the reporting commands, fixing `issue 351`_.
15341534

1535-
- HTML reports now include a timestamp in the footer, closing `issue 299`_.
1535+
- HTML reports now include a time stamp in the footer, closing `issue 299`_.
15361536
Thanks, Conrad Ho.
15371537

15381538
- HTML reports now begrudgingly use double-quotes rather than single quotes,
@@ -1685,7 +1685,7 @@ Version 4.0a2 — 2015-01-14
16851685
`issue 328`_. Thanks, Buck Evan.
16861686

16871687
- The regex for matching exclusion pragmas has been fixed to allow more kinds
1688-
of whitespace, fixing `issue 334`_.
1688+
of white space, fixing `issue 334`_.
16891689

16901690
- Made some PyPy-specific tweaks to improve speed under PyPy. Thanks, Alex
16911691
Gaynor.
@@ -1739,7 +1739,7 @@ Version 4.0a1 — 2014-09-27
17391739
`issue 285`_. Thanks, Chris Rose.
17401740

17411741
- HTML reports no longer raise UnicodeDecodeError if a Python file has
1742-
undecodable characters, fixing `issue 303`_ and `issue 331`_.
1742+
un-decodable characters, fixing `issue 303`_ and `issue 331`_.
17431743

17441744
- The annotate command will now annotate all files, not just ones relative to
17451745
the current directory, fixing `issue 57`_.
@@ -1791,7 +1791,7 @@ Version 3.7 — 2013-10-06
17911791
- Coverage.py properly supports .pyw files, fixing `issue 261`_.
17921792

17931793
- Omitting files within a tree specified with the ``source`` option would
1794-
cause them to be incorrectly marked as unexecuted, as described in
1794+
cause them to be incorrectly marked as un-executed, as described in
17951795
`issue 218`_. This is now fixed.
17961796

17971797
- When specifying paths to alias together during data combining, you can now
@@ -1802,7 +1802,7 @@ Version 3.7 — 2013-10-06
18021802
(``build/$BUILDNUM/src``).
18031803

18041804
- Trying to create an XML report with no files to report on, would cause a
1805-
ZeroDivideError, but no longer does, fixing `issue 250`_.
1805+
ZeroDivisionError, but no longer does, fixing `issue 250`_.
18061806

18071807
- When running a threaded program under the Python tracer, coverage.py no
18081808
longer issues a spurious warning about the trace function changing: "Trace
@@ -1905,7 +1905,7 @@ Version 3.6b1 — 2012-11-28
19051905
Thanks, Marcus Cobden.
19061906

19071907
- Coverage percentage metrics are now computed slightly differently under
1908-
branch coverage. This means that completely unexecuted files will now
1908+
branch coverage. This means that completely un-executed files will now
19091909
correctly have 0% coverage, fixing `issue 156`_. This also means that your
19101910
total coverage numbers will generally now be lower if you are measuring
19111911
branch coverage.
@@ -2068,7 +2068,7 @@ Version 3.5.2b1 — 2012-04-29
20682068
- Now the exit status of your product code is properly used as the process
20692069
status when running ``python -m coverage run ...``. Thanks, JT Olds.
20702070

2071-
- When installing into pypy, we no longer attempt (and fail) to compile
2071+
- When installing into PyPy, we no longer attempt (and fail) to compile
20722072
the C tracer function, closing `issue 166`_.
20732073

20742074
.. _issue 142: https://github.com/nedbat/coveragepy/issues/142
@@ -2234,7 +2234,7 @@ Version 3.4 — 2010-09-19
22342234
Version 3.4b2 — 2010-09-06
22352235
--------------------------
22362236

2237-
- Completely unexecuted files can now be included in coverage results, reported
2237+
- Completely un-executed files can now be included in coverage results, reported
22382238
as 0% covered. This only happens if the --source option is specified, since
22392239
coverage.py needs guidance about where to look for source files.
22402240

@@ -2374,7 +2374,7 @@ Version 3.3 — 2010-02-24
23742374
`config_file=False`.
23752375

23762376
- Fixed a problem with nested loops having their branch possibilities
2377-
mischaracterized: `issue 39`_.
2377+
mis-characterized: `issue 39`_.
23782378

23792379
- Added coverage.process_start to enable coverage measurement when Python
23802380
starts.

doc/cmd.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1025,7 +1025,7 @@ of operation to log:
10251025
* ``plugin``: print information about plugin operations.
10261026

10271027
* ``process``: show process creation information, and changes in the current
1028-
directory. This also writes a timestamp and command arguments into the data
1028+
directory. This also writes a time stamp and command arguments into the data
10291029
file.
10301030

10311031
* ``pybehave``: show the values of `internal flags <env.py_>`_ describing the

doc/config.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -419,9 +419,9 @@ See :ref:`source` for details.
419419
[report] include_namespace_packages
420420
...................................
421421

422-
(boolean, default False) When searching for completely unexecuted files,
422+
(boolean, default False) When searching for completely un-executed files,
423423
include directories without ``__init__.py`` files. These are `implicit
424-
namespace packages`_, and are ususally skipped.
424+
namespace packages`_, and are usually skipped.
425425

426426
.. _implicit namespace packages: https://peps.python.org/pep-0420/
427427

@@ -617,7 +617,7 @@ section also apply to JSON output, where appropriate.
617617
[json] pretty_print
618618
...................
619619

620-
(boolean, default false) Controls if the JSON is outputted with whitespace
620+
(boolean, default false) Controls if the JSON is outputted with white space
621621
formatted for human consumption (True) or for minimum file size (False).
622622

623623

doc/dict.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,6 @@ templite
221221
templating
222222
testability
223223
Tidelift
224-
timestamp
225224
todo
226225
TODO
227226
tokenization
@@ -241,7 +240,6 @@ txt
241240
ubuntu
242241
undecodable
243242
unexecutable
244-
unexecuted
245243
unicode
246244
uninstall
247245
unittest
@@ -256,7 +254,6 @@ utf
256254
vendored
257255
versionadded
258256
virtualenv
259-
whitespace
260257
wikipedia
261258
wildcard
262259
wildcards

doc/source.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ modules).
3232

3333
If the source option is specified, only code in those locations will be
3434
measured. Specifying the source option also enables coverage.py to report on
35-
unexecuted files, since it can search the source tree for files that haven't
35+
un-executed files, since it can search the source tree for files that haven't
3636
been measured at all. Only importable files (ones at the root of the tree, or
3737
in directories with a ``__init__.py`` file) will be considered. Files with
3838
unusual punctuation in their names will be skipped (they are assumed to be

igor.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ def do_zip_mods():
276276

277277

278278
def do_check_eol():
279-
"""Check files for incorrect newlines and trailing whitespace."""
279+
"""Check files for incorrect newlines and trailing white space."""
280280

281281
ignore_dirs = [
282282
'.svn', '.hg', '.git',
@@ -290,7 +290,7 @@ def do_check_eol():
290290
checked = set()
291291

292292
def check_file(fname, crlf=True, trail_white=True):
293-
"""Check a single file for whitespace abuse."""
293+
"""Check a single file for white space abuse."""
294294
fname = os.path.relpath(fname)
295295
if fname in checked:
296296
return
@@ -308,14 +308,14 @@ def check_file(fname, crlf=True, trail_white=True):
308308
if not crlf:
309309
line = line.rstrip(b'\r')
310310
if line.rstrip() != line:
311-
print(f"{fname}@{n}: trailing whitespace found")
311+
print(f"{fname}@{n}: trailing white space found")
312312
return
313313

314314
if line is not None and not line.strip():
315315
print(f"{fname}: final blank line")
316316

317317
def check_files(root, patterns, **kwargs):
318-
"""Check a number of files for whitespace abuse."""
318+
"""Check a number of files for white space abuse."""
319319
for where, dirs, files in os.walk(root):
320320
for f in files:
321321
fname = os.path.join(where, f)

tests/mixins.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ def clean_local_file_imports(self):
9999
# So that we can re-import files, clean them out first.
100100
self._sys_module_saver.restore()
101101

102-
# Also have to clean out the .pyc files, since the timestamp
102+
# Also have to clean out the .pyc files, since the time stamp
103103
# resolution is only one second, a changed file might not be
104104
# picked up.
105105
remove_tree("__pycache__")

0 commit comments

Comments
 (0)