Skip to content

Commit 4b155b1

Browse files
committed
fix details in docs and example
1 parent 0d4ea0e commit 4b155b1

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

doc/users/interface_tutorial.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Settings can be saved to a json file:
5050
mybet = fsl.BET(in_file='foo.nii', out_file='bar.nii', frac=0.5)
5151
mybet.save_inputs_to_json('bet-settings.json')
5252

53-
Once saved, the three inputs set for `mybet` will be stored in a JSON
53+
Once saved, the three inputs set for ``mybet`` will be stored in a JSON
5454
file. These settings can also be loaded from a json file:
5555

5656
.. testcode::
@@ -61,7 +61,7 @@ file. These settings can also be loaded from a json file:
6161

6262

6363
Loading settings will overwrite previously set inputs by default, unless
64-
the `overwrite` argument is `False`. Conveniently, the settings can be
64+
the ``overwrite`` argument is ``False``. Conveniently, the settings can be
6565
also read during the interface instantiation:
6666

6767
.. testcode::
@@ -70,15 +70,15 @@ also read during the interface instantiation:
7070
mybet = fsl.BET(from_file='bet-settings.json')
7171

7272
If the user provides settings during interface creation, they will take
73-
precedence over those loaded using `from_file`:
73+
precedence over those loaded using ``from_file``:
7474

7575
.. testcode::
7676

7777
import nipype.interfaces.fsl as fsl
7878
mybet = fsl.BET(from_file='bet-settings.json', frac=0.7)
7979

80-
In this case, `mybet.inputs.frac` will contain the value `0.7` regardless
81-
the value that could be stored in the `bet-settings.json` file.
80+
In this case, ``mybet.inputs.frac`` will contain the value ``0.7`` regardless
81+
the value that could be stored in the ``bet-settings.json`` file.
8282

8383

8484
Getting Help

examples/smri_ants_registration.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
coregister two T1 volumes.
1111
1212
1. Tell python where to find the appropriate functions.
13+
1314
"""
15+
1416
from __future__ import print_function, unicode_literals
1517
from builtins import open
1618

@@ -25,6 +27,7 @@
2527

2628
"""
2729
2. Download T1 volumes into home directory
30+
2831
"""
2932

3033
homeDir = os.getenv("HOME")
@@ -58,15 +61,16 @@
5861

5962
"""
6063
3. Define the parameters of the registration. Settings are
61-
saved in `./smri_ants_registration_settings.json`.
64+
saved in ``smri_ants_registration_settings.json``.
65+
6266
"""
6367

6468
reg = Registration(from_file='./smri_ants_registration_settings.json')
6569
reg.inputs.fixed_image = input_images[0]
6670
reg.inputs.moving_image = input_images[1]
6771

6872
"""
69-
Alternatively to the use of the `from_file` feature to load ANTs settings,
73+
Alternatively to the use of the ``from_file`` feature to load ANTs settings,
7074
the user can manually set all those inputs instead::
7175
7276
reg.inputs.output_transform_prefix = 'thisTransform'
@@ -94,6 +98,7 @@
9498
reg.inputs.initial_moving_transform_com = True
9599
96100
"""
101+
97102
print(reg.cmdline)
98103

99104

0 commit comments

Comments
 (0)