fix markdown

Author: Remi-Gau

notebooks/README.md

@@ -1,13 +1,17 @@
 # README
 
-1. Make sure that you have Octave installed.
-2. If you have Conda/Jupyter/pip installed, go to step 4.
-Check if Conda is installed properly by typing `conda list` into your terminal
-3. Download the [Anaconda Installer](https://www.anaconda.com/products/individual) and install it.
-If using miniconda, run `conda install jupyter` to download and install the Jupyter Notebook package.
-4. Install [Octave kernel](https://pypi.org/project/octave-kernel/):
-   ```
-   pip install octave_kernel
-   ```
-5. Run `jupyter notebook` in your terminal. `Octave` should appear on the list
-   for creating a new notebook.
+1.  Make sure that you have Octave installed.
+
+2.  If you have Conda/Jupyter/pip installed, go to step 4. Check if Conda is
+    installed properly by typing `conda list` into your terminal
+
+3.  Download the
+    [Anaconda Installer](https://www.anaconda.com/products/individual) and
+    install it. If using miniconda, run `conda install jupyter` to download and
+    install the Jupyter Notebook package.
+
+4.  Install [Octave kernel](https://pypi.org/project/octave-kernel/): 
+    `pip install octave_kernel`
+
+5.  Run `jupyter notebook` in your terminal. `Octave` should appear on the list
+    for creating a new notebook.

tests/README.md

@@ -1,31 +1,40 @@
 # how to run the tests
 
-- Install [MOxUnit for matlab and octave](https://github.com/MOxUnit/MOxUnit) to run the tests
-- Install [MOcov for matlab and octave](https://github.com/MOcov/MOcov) to get the code coverage
-- Make sure you are in the `tests` directory.
-- Run `moxunit_runtests` or `moxunit_runtests -verbose` to run the tests.
+-   Install [MOxUnit for matlab and octave](https://github.com/MOxUnit/MOxUnit)
+    to run the tests
+
+-   Install [MOcov for matlab and octave](https://github.com/MOcov/MOcov) to get
+    the code coverage
+
+-   Make sure you are in the `tests` directory.
+
+-   Run `moxunit_runtests` or `moxunit_runtests -verbose` to run the tests.
 
 This should tell you which tests pass or fail.
-  
+
 ## code coverage
 
-The following command would give more info and will give you HTML output in a `coverage_html` folder
-showing you which lines of code is or is not checked by your test suite.
+The following command would give more info and will give you HTML output in a
+`coverage_html` folder showing you which lines of code is or is not checked by
+your test suite.
 
-``` matlab
+```matlab
 success = moxunit_runtests(pwd, ... % the path where the tests are
     '-verbose', ...
     '-with_coverage', ...
     '-cover', fullfile(pwd, '..'), ... % the path of the code whose coverage we want to estimate
     '-cover_xml_file','coverage.xml', ...
     '-cover_html_dir','coverage_html');
 ```
-This will return a clear underestimation of the code coverage as the the code in dependencies in the `lib` folder
-are also included in this report.
 
-If you want to get a slightly more accurate estimate you should run the following.
+This will return a clear underestimation of the code coverage as the the code in
+dependencies in the `lib` folder are also included in this report.
+
+If you want to get a slightly more accurate estimate you should run the
+following.
 
-I have not been able to find a way to exclude certain files without breaking some tests.
+I have not been able to find a way to exclude certain files without breaking
+some tests.
 
 ```matlab
 coverage = mocov( ...
@@ -47,15 +56,13 @@ coverage = mocov( ...
     '-cover_html_dir','coverage_html')
 ```
 
-
 ## Adding more tests
 
 You can use the following function template to write more tests.
 
-
 ```matlab
 function test_suite = test_functionToTest()
-    % This top function is necessary for mox unit to run tests. 
+    % This top function is necessary for mox unit to run tests.
     % DO NOT CHANGE IT except to adapt the name of the function.
     try % assignment of 'localfunctions' is necessary in Matlab >= 2016
         test_functions = localfunctions(); %#ok<*NASGU>
@@ -70,7 +77,7 @@ function test_functionToTestBasic()
 
 
     %% data to test against
-    
+
 
     %% test
     % assertTrue( );
@@ -85,7 +92,7 @@ function test_functionToTestUseCase1()
 
 
     %% data to test against
-    
+
 
     %% test
     % assertTrue( );
@@ -94,4 +101,3 @@ function test_functionToTestUseCase1()
 
 end
 ```
-