Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Remi-Gau committed Jan 28, 2022
1 parent f5c1af9 commit c44291b
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 20 deletions.
3 changes: 0 additions & 3 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,3 @@ help:
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc:
@$(SPHINXBUILD) -b html "$(SOURCEDIR)" "$(BUILDDIR)"
34 changes: 17 additions & 17 deletions src/defaults/check_cfg.m
Original file line number Diff line number Diff line change
Expand Up @@ -14,38 +14,38 @@
%
% - :cfg: the option structure with missing values filled in by the defaults.
%
% ``cfg`` fields::
% ``cfg`` fields:
%
% :param entity_order: order of the entities in bids derivatives
% :param fwhm: value to append to smoothing desctiption label
% :param spec: specfication details to over ride some of the defaults
% - ``entity_order``: order of the entities in bids derivatives
% - ``fwhm``: value to append to smoothing desctiption label
% - ``spec``: specfication details to over ride some of the defaults
%
% BIDS derivatives defining fields:
%
% Each of those fields contain a structure that lists the BIDS suffix
% and entities-label pairs for each type of preprocessed image.
%
% :param segment:
% :param stc:
% :param realign_unwarp:
% :param real_param:
% :param mean:
% :param normalized_mean:
% :param preproc:
% :param preproc_norm:
% :param smooth:
% :param smooth_norm:
% - ``segment``
% - ``stc``
% - ``realign_unwarp``
% - ``real_param``
% - ``mean``
% - ``normalized_mean``
% - ``preproc``
% - ``preproc_norm``
% - ``smooth``
% - ``smooth_norm``
%
% For example::
% For example:
%
% .. code-block:: matlab
%
% % for grey matter segmentation output
% cfg.segment.gm = struct('entities', struct('space', 'individual', ...
% 'label', x), ...
% 'suffix', 'probseg')
%
%
% :mapping: a n X 2 cell that maps a prefix ``mapping{i, 1}`` to a
% to a given bids-derivatives name specification ``mapping{i, 2}``
%
% (C) Copyright 2021 spm_2_bids developers

Expand Down

0 comments on commit c44291b

Please sign in to comment.