Commit c3693b69 authored by Stéphane Adjemian's avatar Stéphane Adjemian
Browse files

Updated doc.

parent 52c0ea20
......@@ -49,7 +49,7 @@ master_doc = 'index'
# General information about the project.
project = u'm-unit-tests'
copyright = u'2014, Stéphane Adjemian'
copyright = u'2014-2018, DynareTeam'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
......
......@@ -107,9 +107,9 @@ Contents:
**INPUTS**
- ``dirname`` (*string*) Path to the directory.
- ``savereport`` (*integer*) Scalar equal to ``0`` or ``1``. If equal to ``1`` generated report is saved in a ``*.mat`` file.
- ``printreport`` (*integer*) Scalar equal to ``0`` or ``1``. If equal to ``1`` generated report is printed on screen.
- ``sendreport`` (*integer*) Scalar equal to ``0`` or ``1``. If equal to ``1`` generated report is sent by email.
- ``savereport`` (*logical*) Scalar equal to ``false`` or ``true``. If equal to ``true`` generated report is saved in a ``*.mat`` file.
- ``printreport`` (*logical*) Scalar equal to ``false`` or ``true``. If equal to ``true`` generated report is printed on screen.
- ``sendreport`` (*string*) Email adress. If not empty generated report is sent by email.
**OUTPUTS**
- ``report`` (*cell*) First output argument of :func:`run_unitary_test routine`.
......@@ -118,6 +118,14 @@ Contents:
1. Git needs to be available on the system, and it is assumed that the content of ``dirname`` is versionned with Git.
.. function:: display_report(report)
Displays detailed report for the testsuite.
**INPUTS**
- ``report`` (*cell*) Output of :func:`run_unitary_tests_in_directory`.
Indices and tables
==================
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment