Skip to content

Commit e752460

Browse files
committed
mh fix
1 parent e9b886b commit e752460

File tree

5 files changed

+89
-80
lines changed

5 files changed

+89
-80
lines changed

src/readAndFilterLogfile.m

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@
1919
% :type filterBy: string
2020
% :param varargin: either ``cfg`` (to display the last run output) or the file path as string
2121
%
22-
% :returns: - :outputFiltered: dataset with only the specified content to see it in the command window use display(outputFiltered)
22+
% :returns:
23+
%
24+
% - :outputFiltered: dataset with only the specified content to see it in the
25+
% command window use display(outputFiltered)
2326
%
2427
%
2528

src/templates/templateFunction.m

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,29 @@
1-
% (C) Copyright 2020 CPP_PTB developpers
1+
% (C) Copyright 2020 CPP_PTB developers
22

33
function [argout1, argout2] = templateFunction(argin1, argin2, argin3)
4-
%
5-
% Short description of what the function does goes here.
6-
%
7-
% USAGE::
8-
%
9-
% [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
10-
%
11-
% :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
12-
% consectetur adipiscing elit. Ut congue nec est ac lacinia.
13-
% :type argin1: type
14-
% :param argin2: optional argument and its default value. And some of the
15-
% options can be shown in litteral like ``this`` or ``that``.
16-
% :type argin2: string
17-
% :param argin3: (dimension) optional argument
18-
%
19-
% :returns: - :argout1: (type) (dimension)
20-
% - :argout2: (type) (dimension)
21-
%
22-
% .. todo:
23-
%
24-
% - item 1
25-
% - item 2
4+
%
5+
% Short description of what the function does goes here.
6+
%
7+
% USAGE::
8+
%
9+
% [argout1, argout2] = templateFunction(argin1, [argin2 == default,] [argin3])
10+
%
11+
% :param argin1: (dimension) obligatory argument. Lorem ipsum dolor sit amet,
12+
% consectetur adipiscing elit. Ut congue nec est ac lacinia.
13+
% :type argin1: type
14+
% :param argin2: optional argument and its default value. And some of the
15+
% options can be shown in litteral like ``this`` or ``that``.
16+
% :type argin2: string
17+
% :param argin3: (dimension) optional argument
18+
%
19+
% :returns: - :argout1: (type) (dimension)
20+
% - :argout2: (type) (dimension)
21+
%
22+
% .. todo:
23+
%
24+
% - item 1
25+
% - item 2
2626

27-
% The code goes below
27+
% The code goes below
2828

2929
end
Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
1-
% (C) Copyright 2020 CPP_PTB developpers
1+
% (C) Copyright 2020 CPP_PTB developers
22

33
function templateFunctionExample()
4-
% This function illustrates a documentation test defined for MOdox.
5-
% Other than that it does absolutely nothinghort description of what
6-
% the function does goes here.
7-
%
8-
% Examples:
9-
% a=2;
10-
% disp(a)
11-
% % Expected output is prefixed by '%||' as in the following line:
12-
% %|| 2
13-
% %
14-
% % The test continues because no interruption through whitespace,
15-
% % as the previous line used a '%' comment character;
16-
% % thus the 'a' variable is still in the namespace and can be
17-
% % accessed.
18-
% b=3+a;
19-
% disp(a+[3 4])
20-
% %|| [5 6]
21-
%
22-
% % A new test starts here because the previous line was white-space
23-
% % only. Thus the 'a' and 'b' variables are not present here anymore.
24-
% % The following expression raises an error because the 'b' variable
25-
% % is not defined (and does not carry over from the previous test).
26-
% % Because the expected output indicates an error as well,
27-
% % the test passes
28-
% disp(b)
29-
% %|| error('Some error')
30-
%
31-
% % A set of expressions is ignored if there is no expected output
32-
% % (that is, no lines starting with '%||').
33-
% % Thus, the following expression is not part of any test,
34-
% % and therefore does not raise an error.
35-
% error('this is never executed)
36-
%
37-
%
38-
% % tests end here because test indentation has ended
4+
% This function illustrates a documentation test defined for MOdox.
5+
% Other than that it does absolutely nothinghort description of what
6+
% the function does goes here.
7+
%
8+
% Examples:
9+
% a=2;
10+
% disp(a)
11+
% % Expected output is prefixed by '%||' as in the following line:
12+
% %|| 2
13+
% %
14+
% % The test continues because no interruption through whitespace,
15+
% % as the previous line used a '%' comment character;
16+
% % thus the 'a' variable is still in the namespace and can be
17+
% % accessed.
18+
% b=3+a;
19+
% disp(a+[3 4])
20+
% %|| [5 6]
21+
%
22+
% % A new test starts here because the previous line was white-space
23+
% % only. Thus the 'a' and 'b' variables are not present here anymore.
24+
% % The following expression raises an error because the 'b' variable
25+
% % is not defined (and does not carry over from the previous test).
26+
% % Because the expected output indicates an error as well,
27+
% % the test passes
28+
% disp(b)
29+
% %|| error('Some error')
30+
%
31+
% % A set of expressions is ignored if there is no expected output
32+
% % (that is, no lines starting with '%||').
33+
% % Thus, the following expression is not part of any test,
34+
% % and therefore does not raise an error.
35+
% error('this is never executed)
36+
%
37+
%
38+
% % tests end here because test indentation has ended
3939

40-
% The code goes below
40+
% The code goes below
4141

4242
end
Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
% (C) Copyright 2020 CPP_PTB developpers
1+
% (C) Copyright 2020 CPP_PTB developers
22

33
function [argout] = templateFunctionNumpy(argin1, argin2, argin3)
4-
%
5-
% Short description of what the function does goes here.
6-
%
7-
% y = templateFunction(argin1, argin2, argin3)
8-
%
9-
% Parameters:
10-
% argin1: The first input value
11-
%
12-
% argin2: The second input value
13-
%
14-
% argin3: The third input value
15-
%
16-
% Returns:
17-
% The input value multiplied by two
4+
%
5+
% Short description of what the function does goes here.
6+
%
7+
% y = templateFunction(argin1, argin2, argin3)
8+
%
9+
% Parameters:
10+
% argin1: The first input value
11+
%
12+
% argin2: The second input value
13+
%
14+
% argin3: The third input value
15+
%
16+
% Returns:
17+
% The input value multiplied by two
1818

19-
% The code goes below
19+
% The code goes below
2020

2121
end

src/waitForTrigger.m

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@
55
%
66
% USAGE:
77
%
8-
% [lastTriggerTimeStamp] = waitForTrigger([cfg,] [deviceNumber,] [quietMode,] [nbTriggersToWait])
8+
% [lastTriggerTimeStamp] = waitForTrigger([cfg,] ...
9+
% [deviceNumber,] ...
10+
% [quietMode,] ...
11+
% [nbTriggersToWait])
912
%
1013
% :param cfg:
1114
% :type cfg: struct
@@ -16,7 +19,10 @@
1619
% :param nbTriggersToWait: number of triggers to wait
1720
% :type nbTriggersToWait: integer
1821
%
19-
% :returns: - :lastTriggerTimeStamp: (optional) it can be used as experimentStart timestamp (``cfg.experimentStart``)
22+
% :returns:
23+
%
24+
% - :lastTriggerTimeStamp: (optional) it can be used as experimentStart
25+
% timestamp (``cfg.experimentStart``)
2026
%
2127
% If you are not using the quietMode, it flips and waits for half a TR before starting to
2228
% check for the next trigger (unless this was the last trigger to wait for and in

0 commit comments

Comments
 (0)