You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -8,13 +8,13 @@ Testing is wonderful! Let's make it easier and more rewarding!
8
8
9
9
The most popular testing platform for MATLAB functions and classes is/was Steve Eddins' excellent [Matlab xUnit](http://www.mathworks.com/matlabcentral/fileexchange/22846-matlab-xunit-test-framework) package.
10
10
11
-
The previous maintainer, [Thomas Smith](https://github.com/tgs/), made two additions to that package: the ability to give output in a JUnit-compatible XML format, and the ability to run DocTests, similar to the ``doctest`` module in Python or vignettes in R.
11
+
The previous maintainer, [Thomas Smith](https://github.com/tgs/), made two additions to that package: the ability to give output in a JUnit-compatible XML format, and the ability to run DocTests, similar to the `doctest` module in Python or vignettes in R.
12
12
13
-
I've made one additional change: renaming ``runtests`` to ``runxunit`` so that it's compatible with MATLAB R2013a and newer. (``runtests`` is now a built-in function.)
13
+
I've made one additional change: renaming `runtests` to `runxunit` so that it's compatible with MATLAB R2013a and newer. (`runtests` is now a built-in function.)
14
14
15
15
## Installation and Usage
16
16
17
-
To install matlab-xunit, clone or download this from GitHub, and put the ``matlab-xunit/src`` and ``matlab-xunit/matlab-xunit`` directories on your MATLAB path (using ``addpath``).
17
+
To install matlab-xunit, clone or download this from GitHub, and put the `matlab-xunit/src` and `matlab-xunit/matlab-xunit` directories on your MATLAB path (using `addpath`).
18
18
19
19
Once you've written some unit tests (see [xUnit's help](https://cdn.rawgit.com/psexton/matlab-xunit/master/doc/xunit_product_page.html)), you can then run:
20
20
@@ -38,7 +38,7 @@ If everything goes well, you'll see some output like this:
38
38
.............
39
39
PASSED in 2.922 seconds.
40
40
41
-
If any of the tests failed, they'll be marked with a ``F`` instead of a ``.`` and more info about the failure will be printed at the end. You can also get more verbose info on all tests, both passes and failures, by using the `-verbose` flag.
41
+
If any of the tests failed, they'll be marked with a `F` instead of a `.` and more info about the failure will be printed at the end. You can also get more verbose info on all tests, both passes and failures, by using the `-verbose` flag.
42
42
43
43
# XML Output
44
44
@@ -52,15 +52,15 @@ And here's a graph of the test trend:
The implementation is based on [xml_io_tools](http://www.mathworks.com/matlabcentral/fileexchange/12907-xmliotools) by Jaroslaw Tuszynski, which is a nice way to generate XML in Matlab. It uses about 1/3 the lines of code as Matlab's built-in ``xmlwrite``.
55
+
The implementation is based on [xml_io_tools](http://www.mathworks.com/matlabcentral/fileexchange/12907-xmliotools) by Jaroslaw Tuszynski, which is a nice way to generate XML in Matlab. It uses about 1/3 the lines of code as Matlab's built-in `xmlwrite`.
56
56
57
57
## Usage
58
58
59
59
Once you've written some unit tests (see [xUnit's help](https://cdn.rawgit.com/psexton/matlab-xunit/master/doc/xunit_product_page.html)), you can then run:
60
60
61
61
runxunit path/to/test/dir -xmlfile testreport.xml
62
62
63
-
Unsurprisingly, this will run your unit tests and put the results into ``testreport.xml`` in the current directory.
63
+
Unsurprisingly, this will run your unit tests and put the results into `testreport.xml` in the current directory.
64
64
65
65
## Usage with Jenkins
66
66
@@ -76,7 +76,7 @@ First, you need a build step that will run the tests. Mine looks something like
0 commit comments