Skip to content

Commit 4b59a77

Browse files
committed
Updating pipeline docstrings
1 parent ebd1f60 commit 4b59a77

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

nipype/pipeline/engine.py

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -226,8 +226,8 @@ def clone(self, name):
226226
Parameters
227227
----------
228228
229-
name: string (mandatory )
230-
every clone requires a new name
229+
name: alphanumeric name
230+
unique name for the workflow
231231
232232
"""
233233
clone = super(Workflow, self).clone(name)
@@ -1072,8 +1072,8 @@ class Node(WorkflowBase):
10721072
Examples
10731073
--------
10741074
1075-
>>> import nipype.interfaces.spm as spm
1076-
>>> realign = Node(interface=spm.Realign(), name='realign')
1075+
>>> from nipype import Node, spm
1076+
>>> realign = Node(spm.Realign(), 'realign')
10771077
>>> realign.inputs.in_files = 'functional.nii'
10781078
>>> realign.inputs.register_to_mean = True
10791079
>>> realign.run() # doctest: +SKIP
@@ -1656,12 +1656,11 @@ class MapNode(Node):
16561656
Examples
16571657
--------
16581658
1659-
>>> import nipype.interfaces.fsl as fsl
1660-
>>> realign = MapNode(interface=fsl.MCFLIRT(), name='realign',
1661-
iterfield=['in_file']) # doctest: +SKIP
1659+
>>> from nipype import MapNode, fsl
1660+
>>> realign = MapNode(fsl.MCFLIRT(), 'in_file', 'realign')
16621661
>>> realign.inputs.in_file = ['functional.nii',
16631662
'functional2.nii',
1664-
'functional3.nii'] # doctest: +SKIP
1663+
'functional3.nii']
16651664
>>> realign.run() # doctest: +SKIP
16661665
16671666
"""

0 commit comments

Comments
 (0)