Skip to content

Commit ee0330f

Browse files
committed
Update documentation
1 parent 7efa483 commit ee0330f

File tree

2 files changed

+13
-45
lines changed

2 files changed

+13
-45
lines changed

docs/dev/coverage.md

Lines changed: 9 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,7 @@ The coverage information generated will look something like this:
4747
│ └── my-test-1
4848
│ └── my-test-1.tix
4949
└── html
50-
├── my-library-0.1.0.0
51-
│   ├── my-library-0.1.0.0-ERSaOroBZhe9awsoBkhmcV
52-
│   │ ├── My.Lib.Config.hs.html
53-
│   │ ├── My.Lib.Types.hs.html
54-
│   │ └── My.Lib.Util.hs.html
55-
│   ├── hpc_index_alt.html
56-
│   ├── hpc_index_exp.html
57-
│   ├── hpc_index_fun.html
58-
│   └── hpc_index.html
59-
└── my-test-1
50+
└── my-library-0.1.0.0
6051
├── my-library-0.1.0.0-ERSaOroBZhe9awsoBkhmcV
6152
│ ├── My.Lib.Config.hs.html
6253
│ ├── My.Lib.Types.hs.html
@@ -79,11 +70,6 @@ The coverage information generated will look something like this:
7970
respective tix files.
8071
- `html/my-library-0.1.0.0/hpc_index.html` contains coverage
8172
information for the library, excluding any test modules.
82-
- `html/my-test-1/hpc_index.html` contains the coverage information
83-
that the test contributes to the library, excluding any test modules.
84-
- The library might have 100% coverage, 50% generated by test-1
85-
and 50% generated by test-2. The HTML reports for each test will
86-
only show 50% coverage, but the library will show 100% coverage.
8773

8874
### Project-wide reports
8975

@@ -132,32 +118,14 @@ like this:
132118
│   ├── hpc_index_exp.html
133119
│   ├── hpc_index_fun.html
134120
│   └── hpc_index.html
135-
├── my-test-1
136-
│   ├── my-library-0.1.0.0-ERSaOroBZhe9awsoBkhmcV
137-
│   │ ├── My.Lib.Config.hs.html
138-
│   │ ├── My.Lib.Types.hs.html
139-
│   │ └── My.Lib.Util.hs.html
140-
│   ├── hpc_index_alt.html
141-
│   ├── hpc_index_exp.html
142-
│   ├── hpc_index_fun.html
143-
│   └── hpc_index.html
144-
├── other-libray-0.1.0.0
145-
│   ├── other-library-0.1.0.0-48EVZBwW9Kj29VTaRMhBDf
146-
│   │   ├── Other.Lib.A.hs.html
147-
│   │   └── Other.Lib.B.hs.html
148-
│   ├── hpc_index_alt.html
149-
│   ├── hpc_index_exp.html
150-
│   ├── hpc_index_fun.html
151-
│   └── hpc_index.html
152-
├── other-test-1
153-
│   ├── other-library-0.1.0.0-48EVZBwW9Kj29VTaRMhBDf
154-
│   │   ├── Other.Lib.A.hs.html
155-
│   │   └── Other.Lib.B.hs.html
156-
│   ├── hpc_index_alt.html
157-
│   ├── hpc_index_exp.html
158-
│   ├── hpc_index_fun.html
159-
│   └── hpc_index.html
160-
└── index.html
121+
└── other-libray-0.1.0.0
122+
├── other-library-0.1.0.0-48EVZBwW9Kj29VTaRMhBDf
123+
│   ├── Other.Lib.A.hs.html
124+
│   └── Other.Lib.B.hs.html
125+
├── hpc_index_alt.html
126+
├── hpc_index_exp.html
127+
├── hpc_index_fun.html
128+
└── hpc_index.html
161129
```
162130

163131
All of the coverage information is copied verbatim from the coverage

docs/tutorials/coverage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ in {
3939
nix-build default.nix -A "projectWithCoverage.$pkg.coverageReport"
4040
```
4141

42-
This will generate a coverage report for the package you requested. By
43-
default, all tests that are enabled (configured with
44-
`doCheck == true`) are included in the coverage report.
42+
This will generate a coverage report for the package you requested.
43+
All tests that are enabled (configured with `doCheck == true`) are
44+
included in the coverage report.
4545

4646
See the [developer coverage docs](../dev/coverage.md#package-reports) for more information.
4747

@@ -62,7 +62,7 @@ By default, `projectCoverageReport` generates a coverage report
6262
including all the packages in your project, and `coverageReport`
6363
generates a report for the library and all enabled tests in the
6464
requested package. You can modify what is included in each report by
65-
using the `coverageReport` and `projectCoverageReport` functions.
65+
using the `coverageReport'` and `projectCoverageReport'` functions.
6666
These are found in the haskell.nix library:
6767

6868
```nix

0 commit comments

Comments
 (0)