From c3693b6953529c2e7112eb227cce3ae5b651c501 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?St=C3=A9phane=20Adjemian=28Charybdis=29?=
<stephane.adjemian@univ-lemans.fr>
Date: Fri, 14 Sep 2018 15:35:57 +0200
Subject: [PATCH] Updated doc.
---
doc/source/conf.py | 2 +-
doc/source/index.rst | 14 +++++++++++---
2 files changed, 12 insertions(+), 4 deletions(-)
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 08f4374..da8a1e8 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -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
diff --git a/doc/source/index.rst b/doc/source/index.rst
index af4cefb..8035223 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -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
==================
--
GitLab