From 815efad1d5f6ac13af76e7a1467a1a9852b06394 Mon Sep 17 00:00:00 2001 From: marcobarilari Date: Mon, 16 Nov 2020 20:03:03 +0100 Subject: [PATCH 1/4] minor fix on the doc to build rtd --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index d34286ac..7d772758 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ ```bash virtualenv -p python3 cpp_bids -source cpp_spm/bin/activate +source cpp_bids/bin/activate pip install -r requirements.txt ``` From 31b5542f2cf0b032a2891c27b9f0388eba48a930 Mon Sep 17 00:00:00 2001 From: marcobarilari Date: Mon, 16 Nov 2020 20:55:50 +0100 Subject: [PATCH 2/4] sphynx fix --- src/convertSourceToRaw.m | 11 +++++------ src/createFilename.m | 10 +++++----- src/createJson.m | 5 +++-- src/gui/setDefaultResponses.m | 2 +- src/utils/returnNbColumns.m | 2 +- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/convertSourceToRaw.m b/src/convertSourceToRaw.m index 3e779a53..293aebd2 100644 --- a/src/convertSourceToRaw.m +++ b/src/convertSourceToRaw.m @@ -10,15 +10,14 @@ function convertSourceToRaw(cfg) % % convertSourceToRaw(cfg) % - % :param cfg: cfg structure is needed only for providing the path in - % ``cfg.dir.output`` + % :param cfg: cfg structure is needed only for providing the path in ``cfg.dir.output``. % :type cfg: structure % % :output: - % - creates dummy README and CHANGE file - % - copy source dir to raw dir - % - remove the date suffix (_date-*) from the files where it is present - % - zips the _stim files. + % - :creates: dummy README and CHANGE file + % - :copy: source dir to raw dir + % - :remove: the date suffix (_date-*) from the files where it is present + % - :zip: the _stim files. sourceDir = fullfile(cfg.dir.output, 'source'); rawDir = fullfile(cfg.dir.output, 'raw'); diff --git a/src/createFilename.m b/src/createFilename.m index dafab64a..c38cb0dc 100644 --- a/src/createFilename.m +++ b/src/createFilename.m @@ -21,11 +21,11 @@ % % The behavior of this function depends on: % - ``cfg.testingDevice``: - % - set to ``pc`` (dummy try) or ``beh`` can work for behavioral experiment. - % - set on ``mri`` for fMRI experiment. - % - set on ``eeg`` or ``ieeg`` can work for electro encephalography or - % intracranial eeg - % - set on ``meg`` can work for magneto encephalography + % + set to ``pc`` (dummy try) or ``beh`` can work for behavioral experiment. + % + set on ``mri`` for fMRI experiment. + % + set on ``eeg`` or ``ieeg`` can work for electro encephalography or intracranial eeg + % + set on ``meg`` can work for magneto encephalography + % % - ``cfg.eyeTracker.do`` set to ``true``, can work for simple eyetracking data. % % See ``test_createFilename`` in the ``tests`` folder for more details on how to use it. diff --git a/src/createJson.m b/src/createJson.m index b5e219f5..a99ab373 100644 --- a/src/createJson.m +++ b/src/createJson.m @@ -26,8 +26,9 @@ function createJson(varargin) % a valid BIDS dataset. % :type extraInfo: structure % - % :output: - :``*.json``: (jsonfile) The file name corresponds to the run + suffix depending on - % the arguments passed in. + % :output: + % - :``*.json``: (jsonfile) The file name corresponds to the run + suffix depending + % on the arguments passed in. % % .. TODO: % diff --git a/src/gui/setDefaultResponses.m b/src/gui/setDefaultResponses.m index d9ff6d35..3376b736 100644 --- a/src/gui/setDefaultResponses.m +++ b/src/gui/setDefaultResponses.m @@ -13,7 +13,7 @@ % % :returns: - :responses: (cell) It contains the response set by default % - :cfg: (structure) Configuration update with ``cfg.debug.do`` set to false if not - % set by the user. + % set by the user. % if nargin < 1 diff --git a/src/utils/returnNbColumns.m b/src/utils/returnNbColumns.m index 09377cba..c46fef34 100644 --- a/src/utils/returnNbColumns.m +++ b/src/utils/returnNbColumns.m @@ -14,7 +14,7 @@ % :type nameExtraColumn: string % % :returns: - :nbCol: (integer) The number of columns associated to one entry of the extra - % column list. + % column list. % thisExtraColumn = logFile(1).extraColumns.(nameExtraColumn); From 297b8f9ccca1f0c69ef8fc71cb881055335ba318 Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Mon, 16 Nov 2020 21:07:44 +0100 Subject: [PATCH 3/4] fixes doc in convertSourceToRaw --- src/convertSourceToRaw.m | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/convertSourceToRaw.m b/src/convertSourceToRaw.m index 293aebd2..edb6dcaf 100644 --- a/src/convertSourceToRaw.m +++ b/src/convertSourceToRaw.m @@ -14,10 +14,10 @@ function convertSourceToRaw(cfg) % :type cfg: structure % % :output: - % - :creates: dummy README and CHANGE file - % - :copy: source dir to raw dir - % - :remove: the date suffix (_date-*) from the files where it is present - % - :zip: the _stim files. + % - :creates: a dummy README and CHANGE file + % - :copies: ``source`` directory to ``raw`` directory + % - :removes: the date suffix ``_date-*`` from the files where it is present + % - :zips: the ``_stim.tsv`` files. sourceDir = fullfile(cfg.dir.output, 'source'); rawDir = fullfile(cfg.dir.output, 'raw'); From c212459b5d54e539f768421ab843f1bcba77aa40 Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Mon, 16 Nov 2020 21:09:06 +0100 Subject: [PATCH 4/4] fix returnNbColumns --- src/utils/returnNbColumns.m | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/utils/returnNbColumns.m b/src/utils/returnNbColumns.m index c46fef34..efba05e3 100644 --- a/src/utils/returnNbColumns.m +++ b/src/utils/returnNbColumns.m @@ -13,7 +13,8 @@ % :param nameExtraColumn: An entry of ``logFile.extraColumns`` % :type nameExtraColumn: string % - % :returns: - :nbCol: (integer) The number of columns associated to one entry of the extra + % :returns: + % - :nbCol: (integer) The number of columns associated to one entry of the extra % column list. %