Skip to content

Commit 49e5b56

Browse files
aramirezjBioPhoton
andauthored
Update packages/plugin-doc-coverage/README.md
Co-authored-by: Michael Hladky <10064416+BioPhoton@users.noreply.github.com>
1 parent 19d43a5 commit 49e5b56

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

packages/plugin-doc-coverage/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ It analyzes your codebase and checks for documentation on different code element
1111

1212
Measured documentation types are mapped to Code PushUp audits in the following way:
1313

14-
- The value is in range 0-100 and represents the documentation coverage for all passed results (_documented / total_)
14+
- `value`: The value is the number of undocumented nodes -> 4
15+
- `displayValue`: `${value} undocumented ${type}` -> 4 undocumented functions
16+
- `score`: 0.5 -> total nodes 8 undocumented 4 -> 8/4
1517
- The score is value converted to 0-1 range
1618
- Missing documentation is mapped to issues in the audit details (undocumented classes, functions, interfaces, etc.)
1719

0 commit comments

Comments
 (0)