Skip to content

Commit 4c714e9

Browse files
committed
DOC: Minor improvements to the literate workflows descriptions.
1 parent 88a3cdb commit 4c714e9

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

sdcflows/workflows/fit/fieldmap.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,9 +191,9 @@ def init_fmap_wf(omp_nthreads=1, debug=False, mode="phasediff", name="fmap_wf"):
191191
# fmt: on
192192

193193
if mode == "phasediff":
194-
workflow.__desc__ = """\
194+
workflow.__postdesc__ = """\
195195
A *B<sub>0</sub>* nonuniformity map (or *fieldmap*) was estimated from the
196-
phase-drift map(s) measure with two consecutive GRE (gradient-recall echo)
196+
phase-drift map(s) measure with two consecutive GRE (gradient-recalled echo)
197197
acquisitions.
198198
"""
199199
phdiff_wf = init_phdiff_wf(omp_nthreads, debug=debug)
@@ -214,7 +214,7 @@ def init_fmap_wf(omp_nthreads=1, debug=False, mode="phasediff", name="fmap_wf"):
214214
from niworkflows.interfaces.images import IntraModalMerge
215215
from ...interfaces.fmap import CheckB0Units
216216

217-
workflow.__desc__ = """\
217+
workflow.__postdesc__ = """\
218218
A *B<sub>0</sub>* nonuniformity map (or *fieldmap*) was directly measured with
219219
an MRI scheme designed with that purpose such as SEI (Spiral-Echo Imaging).
220220
"""
@@ -368,7 +368,7 @@ def init_phdiff_wf(omp_nthreads, debug=False, name="phdiff_wf"):
368368
from ...interfaces.fmap import Phasediff2Fieldmap, PhaseMap2rads, SubtractPhases
369369

370370
workflow = Workflow(name=name)
371-
workflow.__desc__ = f"""\
371+
workflow.__postdesc__ = f"""\
372372
The corresponding phase-map(s) were phase-unwrapped with `prelude` (FSL {PRELUDE.version}).
373373
"""
374374

sdcflows/workflows/fit/pepolar.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ def init_topup_wf(omp_nthreads=1, debug=False, name="pepolar_estimate_wf"):
7272
from ...interfaces.bspline import TOPUPCoeffReorient
7373

7474
workflow = Workflow(name=name)
75-
workflow.__desc__ = f"""\
76-
{_PEPOLAR_DESC} with `topup` @topup (FSL {TOPUP().version}).
75+
workflow.__postdesc__ = f"""\
76+
{_PEPOLAR_DESC} with `topup` (@topup; FSL {TOPUP().version}).
7777
"""
7878

7979
inputnode = pe.Node(
@@ -196,8 +196,8 @@ def init_3dQwarp_wf(omp_nthreads=1, debug=False, name="pepolar_estimate_wf"):
196196
from ...interfaces.utils import Flatten, ConvertWarp
197197

198198
workflow = Workflow(name=name)
199-
workflow.__desc__ = f"""{_PEPOLAR_DESC} \
200-
with `3dQwarp` @afni (AFNI {''.join(['%02d' % v for v in afni.Info().version() or []])}).
199+
workflow.__postdesc__ = f"""{_PEPOLAR_DESC} \
200+
with `3dQwarp` (@afni; AFNI {''.join(['%02d' % v for v in afni.Info().version() or []])}).
201201
"""
202202

203203
inputnode = pe.Node(

0 commit comments

Comments
 (0)