From 2142eaed74e1e049206a9840418a95664e01241b Mon Sep 17 00:00:00 2001 From: Jylpah Date: Sun, 30 Apr 2023 12:53:19 +0300 Subject: [PATCH] Update README.rst Add clarification for abbreviations for "newbie" users --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index 84a85786..933f1a04 100644 --- a/README.rst +++ b/README.rst @@ -117,6 +117,11 @@ Would produce a report like:: ---------------------------------------- TOTAL 353 20 94% +Where, +* `Stmts` refers to the number of statements in your code. +* `Miss` refers to the number of statements that have not been run. +* `Cover` is test coverage, or `(Stmts - Miss) / (Stmts) * 100`. + Documentation =============