Skip to content

Commit 590de5f

Browse files
authored
Documentation for DyalogAPL code coverage (#116)
* init code cov docs * add wiki link to codecov documentation * add parent links to codecov docs
1 parent 7c88911 commit 590de5f

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

docs/code-coverage.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# How to get code coverage reports?
2+
3+
> This is only relevant to people working at Dyalog Ltd.
4+
5+
Checking for code coverage reports is a very important part. Though not very reliable to measure all cases have been tested, code coverage reports give us an assurance that there are no codepaths left unturned with the tests. It helps us remove dead code and refactor code. It is a very helpful testing and refactoring technique.
6+
7+
Find the documentation at on how to generate a code coverage report with Dyalog APL: https://wiki.bramley.dyalog.com/index.php/Code_coverage_reports

readme.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,8 @@ Ullu is a QA for DyalogAPL (can be used to test any APL ideally) which tests spe
1313
## 🎿 Coverage
1414

1515
### 💪 Available Tests
16-
- add (dyadic +)
17-
- divide (dyadic ÷)
18-
- floor (monadic ⌊)
19-
- index of (dyadic ⍳) (Not tested for coverage)
20-
- magnitude (monadic |)
21-
- membership (dyadic ∊) (Not tested for coverage)
22-
- multiply (dyadic ×)
23-
- residue (dyadic |)
24-
- subtract (dyadic -)
25-
- unique (monadic ∪)
26-
- unique mask (monadic ≠)
16+
17+
Check the tests in the [tests](./tests/) folder
2718

2819
### 🧱 In progress and Next up
2920

@@ -38,7 +29,9 @@ Just as the owl represents both wisdom and foolishness the QA also has a dual na
3829
### 🔗 Contrituting guide
3930

4031
- [contributing.md](contributing.md): Guide on how to contribute to the codebase
41-
- [Decision docs](docs/decision): Explains the decisions taken with each step of the codebase and also documents anomalies for future users.
32+
- [How to add tests?](docs/how-to-add-tests.md): Detailed guide on how to add tests
33+
- [Coverage Docs](docs/code-coverage.md): Guide on how to generate code coverage reports
34+
- [Decision docs](docs/decision): Explains the decisions taken with each step of the codebase and also documents anomalies for future users
4235

4336
## ⬇ Usage
4437

0 commit comments

Comments
 (0)