From c4b26cd88abc8434ec4de71edb82a4cc54d5ece1 Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauld.mccarthy@gmail.com>
Date: Thu, 5 May 2016 17:35:00 +0100
Subject: [PATCH] Documentation updates.
---
doc/fsl.data.featdesign.rst | 9 +++++++++
doc/fsl.data.rst | 3 ++-
fsl/data/featdesign.py | 2 +-
fsl/data/image.py | 6 +++---
4 files changed, 15 insertions(+), 5 deletions(-)
create mode 100644 doc/fsl.data.featdesign.rst
diff --git a/doc/fsl.data.featdesign.rst b/doc/fsl.data.featdesign.rst
new file mode 100644
index 000000000..daacb125a
--- /dev/null
+++ b/doc/fsl.data.featdesign.rst
@@ -0,0 +1,9 @@
+:orphan:
+
+fsl.data.featdesign module
+==========================
+
+.. automodule:: fsl.data.featdesign
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.data.rst b/doc/fsl.data.rst
index b1d9ab529..d6c143d57 100644
--- a/doc/fsl.data.rst
+++ b/doc/fsl.data.rst
@@ -6,8 +6,9 @@ fsl.data package
fsl.data.atlases
fsl.data.constants
+ fsl.data.featanalysis
+ fsl.data.featdesign
fsl.data.featimage
- fsl.data.featresults
fsl.data.image
fsl.data.melodicimage
fsl.data.melodicresults
diff --git a/fsl/data/featdesign.py b/fsl/data/featdesign.py
index f46316fbd..655719c2d 100644
--- a/fsl/data/featdesign.py
+++ b/fsl/data/featdesign.py
@@ -36,7 +36,7 @@ A FEAT design matrix may contain the following types of explanatory variables:
- *Basis function* EV. One or more columns derived from a normal EV. A normal
EV with the ``convolve`` value set to ``4``, ``5``, or ``6`` will be
followed by a set of basis function EVs (the number of additional EVs can
- be determined by the ````basisfnum`` flag).
+ be determined by the ``basisfnum`` flag).
- *Voxelwise* EVs. An EV with different values for each voxel. An EV with the
``shape`` value set to ``9`` is a voxelwise EV. The voxel data will be
diff --git a/fsl/data/image.py b/fsl/data/image.py
index bc05875e8..8ca0d1ed2 100644
--- a/fsl/data/image.py
+++ b/fsl/data/image.py
@@ -280,9 +280,9 @@ class Nifti1(object):
neurological orientation, otherwise it is assumed to be in
radiological orientation.
- http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FLIRT/FAQ#What_is_the_format_\
- of_the_matrix_used_by_FLIRT.2C_and_how_does_it_relate_to_the_\
- transformation_parameters.3F
+ See http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/FLIRT/FAQ#What_is_the\
+ _format_of_the_matrix_used_by_FLIRT.2C_and_how_does_it_relate_to\
+ _the_transformation_parameters.3F
"""
import numpy.linalg as npla
return npla.det(self.voxToWorldMat) > 0
--
GitLab