Skip to content

Commit a4f9e41

Browse files
author
Paul Sexton
committed
Update README.md
Removing some superfluous backticks.
1 parent f102364 commit a4f9e41

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Testing is wonderful! Let's make it easier and more rewarding!
88

99
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.
1010

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.
1212

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.)
1414

1515
## Installation and Usage
1616

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`).
1818

1919
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:
2020

@@ -38,7 +38,7 @@ If everything goes well, you'll see some output like this:
3838
.............
3939
PASSED in 2.922 seconds.
4040

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.
4242

4343
# XML Output
4444

@@ -52,15 +52,15 @@ And here's a graph of the test trend:
5252

5353
![Jenkins trend graph](doc/images/jenkins_trend_graph.png)
5454

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``.
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`.
5656

5757
## Usage
5858

5959
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:
6060

6161
runxunit path/to/test/dir -xmlfile testreport.xml
6262

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.
6464

6565
## Usage with Jenkins
6666

@@ -76,7 +76,7 @@ First, you need a build step that will run the tests. Mine looks something like
7676
catch Ex; fprintf(2, Ex.getReport()); quit(1); end; \
7777
quit(0);"
7878

79-
And second, you need to check the Jenkins box that says "Publish JUnit test result report." I tell it to look at ``**/testreport.xml``.
79+
And second, you need to check the Jenkins box that says "Publish JUnit test result report." I tell it to look at `**/testreport.xml`.
8080

8181
Now save the configuration, tell the project to Build Now, and you should have a lovely display of what tests were run, and which failed!
8282

0 commit comments

Comments
 (0)