From c49fee7c37e71413641ccaa34b9a8b2b2cdb93a1 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sun, 18 May 2008 16:38:48 +0300 Subject: Added a description of the '#pragma: no cover' in the README. --- README | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'README') diff --git a/README b/README index 533bff4..fb58879 100644 --- a/README +++ b/README @@ -87,6 +87,25 @@ executed during the tests, a list of files and statement numbers is included in the output. +Excluding some statements from the coverage analysis +==================================================== + +Use "# pragma: no cover" to exclude some statements from being included +in the coverage analysis. The line with that comment is excluded. If +the line is an if, while, def, or similar, with a "body", the body +is also excluded. For example: + + if always_true_during_testing: + print foo + else: # pragma: no cover + print bar + +The last two lines of codes are excluded from coverage analysis even +if the test suite does not execute them. + +You should only use this after thorough consideration. + + Your tests are too slow ======================= -- cgit v1.2.1