Skip to content

Commit e8b4961

Browse files
committed
doc: minor spell checkings etc while reading
1 parent 29f26bd commit e8b4961

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

doc/users/caching_tutorial.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -130,18 +130,18 @@ rather than workflows. Use it: instead of data grabber nodes, use for
130130
instance the `glob` module. To vary parameters, use `for` loops. To make
131131
reusable code, write Python functions.
132132

133-
One good rule of thumb to respect is to avoid the usage of explicite
134-
filenames appart from the outermost inputs and outputs of your
133+
One good rule of thumb to respect is to avoid the usage of explicit
134+
filenames apart from the outermost inputs and outputs of your
135135
processing. The reason being that the caching mechanism of
136136
:mod:`nipy.caching` takes care of generating the unique hashes, ensuring
137-
that, when you vary parameters, files are not overriden by the output of
137+
that, when you vary parameters, files are not overridden by the output of
138138
different computations.
139139

140140
.. topic:: Debuging
141141

142142
If you need to inspect the running environment of the nodes, it may
143143
be useful to know where they were executed. With `nipype.caching`,
144-
you do not control this location as it it encoded by hashes.
144+
you do not control this location as it is encoded by hashes.
145145

146146
To find out where an operation has been persisted, simply look in
147147
it's output variable::

doc/users/function_interface.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Which would print ``4``.
4848

4949
Note that, if you are working interactively, the Function interface is
5050
unable to use functions that are defined within your interpreter session.
51-
(Specifcally, it can't use functions that live in the ``__main__`` namespace).
51+
(Specifically, it can't use functions that live in the ``__main__`` namespace).
5252

5353
Using External Packages
5454
-----------------------
@@ -59,7 +59,7 @@ geared towards neuroimaging, such as Nibabel_, Nipy_, or PyMVPA_.
5959

6060
While this is completely possible (and, indeed, an intended use of the
6161
Function interface), it does come with one important constraint. The
62-
function code you write is excecuted in a standalone environment,
62+
function code you write is executed in a standalone environment,
6363
which means that any external functions or classes you use have to
6464
be imported within the function itself::
6565

@@ -77,7 +77,7 @@ Hello World - Function interface in a workflow
7777
Contributed by: Hänel Nikolaus Valentin
7878

7979
The following snippet of code demonstrates the use of the function interface in
80-
the context of a workflow. Note the use of `import os` within the function as
80+
the context of a workflow. Note the use of ``import os`` within the function as
8181
well as returning the absolute path from the Hello function. The `import` inside
8282
is necessary because functions are coded as strings and do not have to be on the
8383
PYTHONPATH. However any function called by this function has to be available on
@@ -139,7 +139,7 @@ the string would be
139139
add_two_str = "def add_two(val):\n return val + 2\n"
140140

141141
Unlike when using a function object, this input can be set like any other,
142-
meaning that you could write a function that outputs differnet function
142+
meaning that you could write a function that outputs different function
143143
strings depending on some run-time contingencies, and connect that output
144144
the the ``function_str`` input of a downstream Function interface.
145145

doc/users/grabbing_and_sinking.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ to simply iterate over subjects.
3737

3838
However, in the context of complex workflows and given that users typically
3939
arrange their imaging and other data in a semantically hierarchical data store,
40-
an alternate mechanism for reading and writing the data generated by a workflow
40+
an alternative mechanism for reading and writing the data generated by a workflow
4141
is often necessary. As the names suggest DataGrabber is used to get at data
4242
stored in a shared file system while DataSink is used to store the data
4343
generated by a workflow into a hierarchical structure on disk.
@@ -46,8 +46,8 @@ generated by a workflow into a hierarchical structure on disk.
4646
DataGrabber
4747
===========
4848

49-
Datagrabber is an interface for collecting files from hard drive. It is very
50-
flexible and supports almost any file organisation of your data you can imagine.
49+
DataGrabber is an interface for collecting files from hard drive. It is very
50+
flexible and supports almost any file organization of your data you can imagine.
5151

5252
You can use it as a trivial use case of getting a fixed file. By default,
5353
DataGrabber stores its outputs in a field called outfiles.
@@ -60,7 +60,7 @@ DataGrabber stores its outputs in a field called outfiles.
6060
datasource1.inputs.template = 'data/s1/f3.nii'
6161
results = datasource1.run()
6262

63-
Or you can get at all uncompressed nifti files starting with the letter 'f' in
63+
Or you can get at all uncompressed NIfTI files starting with the letter 'f' in
6464
all directories starting with the letter 's'.
6565

6666
::
@@ -75,7 +75,7 @@ path matches of the form `/mass/data/s*/f*`.
7575

7676
.. note::
7777

78-
When used with wildcards (e.g., s* and f* above) Datagrabber does not return
78+
When used with wildcards (e.g., s* and f* above) DataGrabber does not return
7979
data in sorted order. In order to force it to return data in sorted order, one
8080
needs to set the input `sorted = True`. However, when explicitly specifying an
8181
order as we will see below, `sorted` should be set to `False`.
@@ -108,7 +108,7 @@ A more realistic use-case
108108

109109
In a typical study one often wants to grab different files for a given subject
110110
and store them in semantically meaningful outputs. In the following example, we
111-
wish to retrieve all the functional runs and the structural image for subject 's1'.
111+
wish to retrieve all the functional runs and the structural image for the subject 's1'.
112112

113113
::
114114

@@ -147,7 +147,7 @@ iterables that have been used in the workflow. This makes navigating the working
147147
directory a not so pleasant experience. And typically the user is interested in
148148
preserving only a small percentage of these outputs. The DataSink interface can
149149
be used to extract components from this `cache` and store it at a different
150-
location. For XNAT-based storage, see XNATSink.
150+
location. For XNAT-based storage, see :class:`nipype.interfaces.io.XNATSink` .
151151

152152
.. note::
153153

doc/users/install.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ Debian and Ubuntu
3939
~~~~~~~~~~~~~~~~~
4040

4141
Add the `NeuroDebian <http://neuro.debian.org>`_ repository and install
42-
the ``python-nipype`` package using ``apt-get`` or your favourite package
42+
the ``python-nipype`` package using ``apt-get`` or your favorite package
4343
manager.
4444

4545
Mac OS X
4646
~~~~~~~~
4747

48-
The easiest way to get nipype running on MacOSX is to install EPD_ and then add
48+
The easiest way to get nipype running on Mac OS X is to install EPD_ and then add
4949
nibabel and nipype by executing::
5050

5151
easy_install nibabel

0 commit comments

Comments
 (0)