Skip to content

Commit c44291b

Browse files
committed
fix doc
1 parent f5c1af9 commit c44291b

File tree

2 files changed

+17
-20
lines changed

2 files changed

+17
-20
lines changed

docs/Makefile

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,3 @@ help:
1818
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1919
%: Makefile
2020
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
21-
22-
doc:
23-
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)"

src/defaults/check_cfg.m

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -14,38 +14,38 @@
1414
%
1515
% - :cfg: the option structure with missing values filled in by the defaults.
1616
%
17-
% ``cfg`` fields::
17+
% ``cfg`` fields:
1818
%
19-
% :param entity_order: order of the entities in bids derivatives
20-
% :param fwhm: value to append to smoothing desctiption label
21-
% :param spec: specfication details to over ride some of the defaults
19+
% - ``entity_order``: order of the entities in bids derivatives
20+
% - ``fwhm``: value to append to smoothing desctiption label
21+
% - ``spec``: specfication details to over ride some of the defaults
2222
%
2323
% BIDS derivatives defining fields:
2424
%
2525
% Each of those fields contain a structure that lists the BIDS suffix
2626
% and entities-label pairs for each type of preprocessed image.
2727
%
28-
% :param segment:
29-
% :param stc:
30-
% :param realign_unwarp:
31-
% :param real_param:
32-
% :param mean:
33-
% :param normalized_mean:
34-
% :param preproc:
35-
% :param preproc_norm:
36-
% :param smooth:
37-
% :param smooth_norm:
28+
% - ``segment``
29+
% - ``stc``
30+
% - ``realign_unwarp``
31+
% - ``real_param``
32+
% - ``mean``
33+
% - ``normalized_mean``
34+
% - ``preproc``
35+
% - ``preproc_norm``
36+
% - ``smooth``
37+
% - ``smooth_norm``
3838
%
39-
% For example::
39+
% For example:
40+
%
41+
% .. code-block:: matlab
4042
%
4143
% % for grey matter segmentation output
4244
% cfg.segment.gm = struct('entities', struct('space', 'individual', ...
4345
% 'label', x), ...
4446
% 'suffix', 'probseg')
4547
%
4648
%
47-
% :mapping: a n X 2 cell that maps a prefix ``mapping{i, 1}`` to a
48-
% to a given bids-derivatives name specification ``mapping{i, 2}``
4949
%
5050
% (C) Copyright 2021 spm_2_bids developers
5151

0 commit comments

Comments
 (0)