Permalink
Browse files

DOC: explain coverage methods better

  • Loading branch information...
1 parent ac62209 commit 5d429796af3b24d25bb3fc0507531382510c782d @nno nno committed Jan 27, 2016
Showing with 4 additions and 3 deletions.
  1. +4 −3 README.md
View
@@ -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

0 comments on commit 5d42979

Please sign in to comment.