From 2de38f86516f75421dd4153bfe04b29a80162ba1 Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauldmccarthy@gmail.com>
Date: Thu, 11 Jul 2019 17:18:23 +0100
Subject: [PATCH] DOC: Fixes to docs
---
fsl/__init__.py | 3 ++-
fsl/data/image.py | 2 +-
fsl/transform/nonlinear.py | 10 +++++-----
3 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/fsl/__init__.py b/fsl/__init__.py
index d0a5a517e..1a3917dc7 100644
--- a/fsl/__init__.py
+++ b/fsl/__init__.py
@@ -13,6 +13,7 @@ following sub-packages:
fsl.data
fsl.utils
fsl.scripts
+ fsl.transform
fsl.version
fsl.wrappers
@@ -22,4 +23,4 @@ following sub-packages:
for details.
"""
-__path__ = __import__('pkgutil').extend_path(__path__, __name__)
+__path__ = __import__('pkgutil').extend_path(__path__, __name__) # noqa
diff --git a/fsl/data/image.py b/fsl/data/image.py
index ac9f514e1..03dfc48a0 100644
--- a/fsl/data/image.py
+++ b/fsl/data/image.py
@@ -224,7 +224,7 @@ class Nifti(notifier.Notifier, meta.Meta):
=============== ========================================================
``'transform'`` The affine transformation matrix has changed. This topic
will occur when the :meth:`voxToWorldMat` is changed.
- ``'header A header field has changed. This will occur when the
+ ``'header'`` A header field has changed. This will occur when the
:meth:`intent` is changed.
=============== ========================================================
""" # noqa
diff --git a/fsl/transform/nonlinear.py b/fsl/transform/nonlinear.py
index 389b137d3..3c6bb9b03 100644
--- a/fsl/transform/nonlinear.py
+++ b/fsl/transform/nonlinear.py
@@ -139,7 +139,7 @@ class NonLinearTransform(fslimage.Image):
reference space.
:arg from_: Reference image space that ``coords`` are defined in
:arg to: Source image space to transform ``coords`` into
- :returns ``coords``, transformed into the source image space
+ :returns: ``coords``, transformed into the source image space
"""
raise NotImplementedError()
@@ -217,7 +217,7 @@ class DisplacementField(NonLinearTransform):
reference space.
:arg from_: Reference image space that ``coords`` are defined in
:arg to: Source image space to transform ``coords`` into
- :returns ``coords``, transformed into the source image space
+ :returns: ``coords``, transformed into the source image space
"""
if from_ is None: from_ = self.refSpace
@@ -400,11 +400,11 @@ class CoefficientField(NonLinearTransform):
:arg to: Source image space to transform ``coords`` into
- :returns ``coords``, transformed into the source image space
-
:arg premat: If ``True``, the inverse :meth:`srcToRefMat` is applied
to the coordinates after the displacements have been
addd.
+
+ :returns: ``coords``, transformed into the source image space
"""
df = self.asDisplacementField(premat=premat)
return df.transform(coords, from_, to)
@@ -629,7 +629,7 @@ def coefficientFieldToDisplacementField(field,
:arg field: :class:`CoefficientField` to convert
- :arg dispType: The type of displcaement field - either ``'relative'`` (the
+ :arg dispType: The type of displacement field - either ``'relative'`` (the
default) or ``'absolute'``.
:arg premat: If ``True`` (the default), the :meth:`srcToRefMat` is
--
GitLab