From 5d429796af3b24d25bb3fc0507531382510c782d Mon Sep 17 00:00:00 2001 From: "Nikolaas N. Oosterhof" Date: Wed, 27 Jan 2016 09:52:26 +0100 Subject: [PATCH] DOC: explain coverage methods better --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 446d314..09210eb 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,7 @@ Coverage can be determined for evaluating a single expression or evaluation of a There are two methods to generate coverage while evaluating such an expression or function handle: -1) the 'file' method (default): - +1) the 'file' method (default). - Coverage information is stored internally by the function `mocov_line_covered`, which keeps this information through the use of persistent variables. Initially the coverage information is reset to being empty. - This method considers all files in a directory (and its subdirectories). - A temporary directory is created where modified versions of each file is stored. @@ -55,7 +54,9 @@ There are two methods to generate coverage while evaluating such an expression o This method runs on both GNU Octave and Matlab, but is typically slow. -2) the 'profile' method uses the Matlab profiler. This method runs on Matlab only, but is generally faster. +2) the 'profile' method. + - It uses the Matlab profiler. + - This method runs on Matlab only (not on GNU Octave), but is generally faster. ### Use cases