From 27e782a3b879157ba052c2da46707d8e673b2f9e Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauld.mccarthy@gmail.com>
Date: Fri, 5 Aug 2016 16:28:26 +0100
Subject: [PATCH] Documentation fixes.
---
fsl/data/image.py | 2 +-
fsl/data/imagewrapper.py | 1 +
fsl/utils/async.py | 4 +---
fsl/utils/memoize.py | 12 +++++++-----
fsl/utils/platform.py | 2 +-
5 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/fsl/data/image.py b/fsl/data/image.py
index 8128ce808..88906cdc2 100644
--- a/fsl/data/image.py
+++ b/fsl/data/image.py
@@ -190,7 +190,7 @@ class Nifti1(object):
def mapIndices(self, sliceobj):
"""Adjusts the given slice object so that it may be used to index the
- underlying ``nibabel.Nifti1Image` object.
+ underlying ``nibabel.Nifti1Image`` object.
See the :meth:`__determineShape` method.
diff --git a/fsl/data/imagewrapper.py b/fsl/data/imagewrapper.py
index 7f9f86e97..6acf0c1ea 100644
--- a/fsl/data/imagewrapper.py
+++ b/fsl/data/imagewrapper.py
@@ -685,6 +685,7 @@ def sliceOverlap(slices, coverage):
the current image coverage.
:returns: One of the following codes:
+
.. autosummary::
OVERLAP_ALL
diff --git a/fsl/utils/async.py b/fsl/utils/async.py
index 01ea1778a..7ee46820d 100644
--- a/fsl/utils/async.py
+++ b/fsl/utils/async.py
@@ -485,13 +485,11 @@ class TaskThreadVeto(Exception):
class TaskThread(threading.Thread):
"""The ``TaskThread`` is a simple thread which runs tasks. Tasks may be
enqueued and dequeued.
-
- .. note::
"""
def __init__(self, *args, **kwargs):
- """Create a ``TaskThread`` """
+ """Create a ``TaskThread``. """
threading.Thread.__init__(self, *args, **kwargs)
diff --git a/fsl/utils/memoize.py b/fsl/utils/memoize.py
index e7883434d..cffb5e4ad 100644
--- a/fsl/utils/memoize.py
+++ b/fsl/utils/memoize.py
@@ -34,12 +34,14 @@ def memoize(args=None, kwargs=None):
If no positional or keyword arguments are specified, the function is
memoized on all arguments. Note that the arguments used for memoization
- must be hashable, as they are used as keys in a dictionary..
+ must be hashable, as they are used as keys in a dictionary.
- .. note:: This decorator must always be called with brackets, e.g.::
- memoize()
- def myfunc():
- ...
+ This decorator must always be called with brackets, e.g. ::
+
+ memoize()
+ def myfunc():
+ # do stuff to be memoized
+
:arg args: A list of positional argument indices.
:arg kwargs: A list of keyword argument names.
diff --git a/fsl/utils/platform.py b/fsl/utils/platform.py
index e40bdfed3..cb20b3850 100644
--- a/fsl/utils/platform.py
+++ b/fsl/utils/platform.py
@@ -37,7 +37,7 @@ log = logging.getLogger(__name__)
WX_UNKNOWN = 0
"""Identifier for the :attr:`Platform.wxFlavour` and
:attr:`Platform.wxPlatform` properties indicating an unknown/undetermined
- flavour/platform.
+flavour/platform.
"""
--
GitLab