Skip to content

Commit 73ec4fb

Browse files
committed
update documentation
1 parent 15692ec commit 73ec4fb

File tree

1 file changed

+28
-7
lines changed

1 file changed

+28
-7
lines changed

doc/cmd.rst

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,9 @@ There are many options:
140140
Include only files whose paths match one of these
141141
patterns. Accepts shell-style wildcards, which must be
142142
quoted.
143+
--include_namespace_packages
144+
Include folders without an __init__.py in the
145+
Coverage.
143146
-m, --module <pyfile> is an importable Python module, not a script
144147
path, to be run as 'python -m' would run it.
145148
--omit=PAT1,PAT2,... Omit files whose paths match one of these patterns.
@@ -160,7 +163,7 @@ There are many options:
160163
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
161164
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
162165
tried. [env: COVERAGE_RCFILE]
163-
.. [[[end]]] (checksum: 05d15818e42e6f989c42894fb2b3c753)
166+
.. [[[end]]] (checksum: 2c92816941a91a9c2c0ae8e23dd02102)
164167
165168
If you want :ref:`branch coverage <branch>` measurement, use the ``--branch``
166169
flag. Otherwise only statement coverage is measured.
@@ -515,6 +518,9 @@ as a percentage.
515518
Include only files whose paths match one of these
516519
patterns. Accepts shell-style wildcards, which must be
517520
quoted.
521+
--include_namespace_packages
522+
Include folders without an __init__.py in the
523+
Coverage.
518524
--omit=PAT1,PAT2,... Omit files whose paths match one of these patterns.
519525
Accepts shell-style wildcards, which must be quoted.
520526
--precision=N Number of digits after the decimal point to display
@@ -532,7 +538,7 @@ as a percentage.
532538
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
533539
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
534540
tried. [env: COVERAGE_RCFILE]
535-
.. [[[end]]] (checksum: 2f8dde61bab2f44fbfe837aeae87dfd2)
541+
.. [[[end]]] (checksum: a831cc0bdc5e14ec46e300f0cf8b5d27)
536542
537543
The ``-m`` flag also shows the line numbers of missing statements::
538544

@@ -634,6 +640,9 @@ Click the keyboard icon in the upper right to see the complete list.
634640
Include only files whose paths match one of these
635641
patterns. Accepts shell-style wildcards, which must be
636642
quoted.
643+
--include_namespace_packages
644+
Include folders without an __init__.py in the
645+
Coverage.
637646
--omit=PAT1,PAT2,... Omit files whose paths match one of these patterns.
638647
Accepts shell-style wildcards, which must be quoted.
639648
--precision=N Number of digits after the decimal point to display
@@ -650,7 +659,7 @@ Click the keyboard icon in the upper right to see the complete list.
650659
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
651660
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
652661
tried. [env: COVERAGE_RCFILE]
653-
.. [[[end]]] (checksum: e3a1a6e24ad9b303ba06d42880ed0219)
662+
.. [[[end]]] (checksum: 2fe1c0beaeb4fbdccbd1e69833233143)
654663
655664
The title of the report can be set with the ``title`` setting in the
656665
``[html]`` section of the configuration file, or the ``--title`` switch on
@@ -715,6 +724,9 @@ compatible with `Cobertura`_.
715724
Include only files whose paths match one of these
716725
patterns. Accepts shell-style wildcards, which must be
717726
quoted.
727+
--include_namespace_packages
728+
Include folders without an __init__.py in the
729+
Coverage.
718730
--omit=PAT1,PAT2,... Omit files whose paths match one of these patterns.
719731
Accepts shell-style wildcards, which must be quoted.
720732
-o OUTFILE Write the XML report to this file. Defaults to
@@ -727,7 +739,7 @@ compatible with `Cobertura`_.
727739
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
728740
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
729741
tried. [env: COVERAGE_RCFILE]
730-
.. [[[end]]] (checksum: 8b239d89534be0b2c69489e10b1352a9)
742+
.. [[[end]]] (checksum: 042eddbe0fc48894c1326645a936a39b)
731743
732744
You can specify the name of the output file with the ``-o`` switch.
733745

@@ -803,6 +815,9 @@ The **json** command writes coverage data to a "coverage.json" file.
803815
Include only files whose paths match one of these
804816
patterns. Accepts shell-style wildcards, which must be
805817
quoted.
818+
--include_namespace_packages
819+
Include folders without an __init__.py in the
820+
Coverage.
806821
--omit=PAT1,PAT2,... Omit files whose paths match one of these patterns.
807822
Accepts shell-style wildcards, which must be quoted.
808823
-o OUTFILE Write the JSON report to this file. Defaults to
@@ -816,7 +831,7 @@ The **json** command writes coverage data to a "coverage.json" file.
816831
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
817832
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
818833
tried. [env: COVERAGE_RCFILE]
819-
.. [[[end]]] (checksum: e53e60cb65d971c35d1db1c08324b72e)
834+
.. [[[end]]] (checksum: a49de4d114bf990dc8422f2ae130d1fc)
820835
821836
You can specify the name of the output file with the ``-o`` switch. The JSON
822837
can be nicely formatted by specifying the ``--pretty-print`` switch.
@@ -851,6 +866,9 @@ The **lcov** command writes coverage data to a "coverage.lcov" file.
851866
Include only files whose paths match one of these
852867
patterns. Accepts shell-style wildcards, which must be
853868
quoted.
869+
--include_namespace_packages
870+
Include folders without an __init__.py in the
871+
Coverage.
854872
-o OUTFILE Write the LCOV report to this file. Defaults to
855873
'coverage.lcov'
856874
--omit=PAT1,PAT2,... Omit files whose paths match one of these patterns.
@@ -862,7 +880,7 @@ The **lcov** command writes coverage data to a "coverage.lcov" file.
862880
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
863881
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
864882
tried. [env: COVERAGE_RCFILE]
865-
.. [[[end]]] (checksum: 16acfbae8011d2e3b620695c5fe13746)
883+
.. [[[end]]] (checksum: 646ab6eca5ae5953a461ae3ac434470f)
866884
867885
Common reporting options are described above in :ref:`cmd_reporting`.
868886
Also see :ref:`Configuration: [lcov] <config_lcov>`.
@@ -924,6 +942,9 @@ For example::
924942
Include only files whose paths match one of these
925943
patterns. Accepts shell-style wildcards, which must be
926944
quoted.
945+
--include_namespace_packages
946+
Include folders without an __init__.py in the
947+
Coverage.
927948
--omit=PAT1,PAT2,... Omit files whose paths match one of these patterns.
928949
Accepts shell-style wildcards, which must be quoted.
929950
--debug=OPTS Debug options, separated by commas. [env:
@@ -932,7 +953,7 @@ For example::
932953
--rcfile=RCFILE Specify configuration file. By default '.coveragerc',
933954
'setup.cfg', 'tox.ini', and 'pyproject.toml' are
934955
tried. [env: COVERAGE_RCFILE]
935-
.. [[[end]]] (checksum: fd7d8fbd2dd6e24d37f868b389c2ad6d)
956+
.. [[[end]]] (checksum: 5e7c1705047e4f289d8ba701ee2ae185)
936957
937958
Other common reporting options are described above in :ref:`cmd_reporting`.
938959

0 commit comments

Comments
 (0)