Skip to content
Snippets Groups Projects
Commit 27e782a3 authored by Paul McCarthy's avatar Paul McCarthy
Browse files

Documentation fixes.

parent 2074457e
No related branches found
No related tags found
No related merge requests found
......@@ -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.
......
......@@ -685,6 +685,7 @@ def sliceOverlap(slices, coverage):
the current image coverage.
:returns: One of the following codes:
.. autosummary::
OVERLAP_ALL
......
......@@ -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)
......
......@@ -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.
......
......@@ -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.
"""
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment