From 55b814ce6246c8020e276be87816750e2833ea05 Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauldmccarthy@gmail.com>
Date: Mon, 1 Apr 2019 19:30:53 +0100
Subject: [PATCH] DOC: Various fixes
---
doc/fsl.utils.tempdir.rst | 4 ++--
doc/fsl.wrappers.fsl_anat.rst | 7 +++++++
doc/fsl.wrappers.rst | 1 +
fsl/wrappers/wrapperutils.py | 28 ++++++++++++++--------------
4 files changed, 24 insertions(+), 16 deletions(-)
create mode 100644 doc/fsl.wrappers.fsl_anat.rst
diff --git a/doc/fsl.utils.tempdir.rst b/doc/fsl.utils.tempdir.rst
index 51b9f93c3..1b8e80df0 100644
--- a/doc/fsl.utils.tempdir.rst
+++ b/doc/fsl.utils.tempdir.rst
@@ -1,5 +1,5 @@
-``fsl.utils.temdir``
-====================
+``fsl.utils.tempdir``
+=====================
.. automodule:: fsl.utils.tempdir
:members:
diff --git a/doc/fsl.wrappers.fsl_anat.rst b/doc/fsl.wrappers.fsl_anat.rst
new file mode 100644
index 000000000..93d96ac09
--- /dev/null
+++ b/doc/fsl.wrappers.fsl_anat.rst
@@ -0,0 +1,7 @@
+``fsl.wrappers.fsl_anat``
+=========================
+
+.. automodule:: fsl.wrappers.fsl_anat
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/doc/fsl.wrappers.rst b/doc/fsl.wrappers.rst
index dfa190bfa..818d5ff68 100644
--- a/doc/fsl.wrappers.rst
+++ b/doc/fsl.wrappers.rst
@@ -10,6 +10,7 @@
fsl.wrappers.flirt
fsl.wrappers.fnirt
fsl.wrappers.fslmaths
+ fsl.wrappers.fsl_anat
fsl.wrappers.fugue
fsl.wrappers.melodic
fsl.wrappers.misc
diff --git a/fsl/wrappers/wrapperutils.py b/fsl/wrappers/wrapperutils.py
index 88db1dc92..373bcf08b 100644
--- a/fsl/wrappers/wrapperutils.py
+++ b/fsl/wrappers/wrapperutils.py
@@ -10,7 +10,7 @@
functions.
-The :func:`cmdwrapper` and :func:`fslwrapper` functions are conenience
+The :func:`cmdwrapper` and :func:`fslwrapper` functions are convenience
decorators which allow you to write your wrapper function such that it simply
generates the command-line needed to respectively run a standard shell
command or a FSL command. For example::
@@ -39,7 +39,7 @@ patterns. For example::
The :func:`fileOrImage` and :func:`fileOrArray` functions can be used to
decorate a wrapper function such that in-memory ``nibabel`` images or Numpy
arrays can be passed in as arguments - they will be automatically saved out to
-files, and then the file names passed into the wrapper function. For exmaple::
+files, and then the file names passed into the wrapper function. For example::
@fileOrImage('src', 'ref')
@@ -225,18 +225,18 @@ def applyArgStyle(style,
========= ========== ===========================
``style`` ``valsep`` Result
========= ========== ===========================
- ``'-'`` ' ' ``-name val1 val2 val3``
- ``'-'`` '"' ``-name "val1 val2 val3"``
- ``'-'`` ',' ``-name val1,val2,val3``
- ``'--'`` ' ' ``--name val1 val2 val3``
- ``'--'`` '"' ``--name "val1 val2 val3"``
- ``'--'`` ',' ``--name val1,val2,val3``
- ``'-='`` ' ' Not supported
- ``'-='`` '"' ``-name="val1 val2 val3"``
- ``'-='`` ',' ``-name=val1,val2,val3``
- ``'--='`` ' ' Not supported
- ``'--='`` '"' ``--name="val1 val2 val3"``
- ``'--='`` ',' ``--name=val1,val2,val3``
+ ``'-'`` ``' '`` ``-name val1 val2 val3``
+ ``'-'`` ``'"'`` ``-name "val1 val2 val3"``
+ ``'-'`` ``','`` ``-name val1,val2,val3``
+ ``'--'`` ``' '`` ``--name val1 val2 val3``
+ ``'--'`` ``'"'`` ``--name "val1 val2 val3"``
+ ``'--'`` ``','`` ``--name val1,val2,val3``
+ ``'-='`` ``' '`` Not supported
+ ``'-='`` ``'"'`` ``-name="val1 val2 val3"``
+ ``'-='`` ``','`` ``-name=val1,val2,val3``
+ ``'--='`` ``' '`` Not supported
+ ``'--='`` ``'"'`` ``--name="val1 val2 val3"``
+ ``'--='`` ``','`` ``--name=val1,val2,val3``
========= ========== ===========================
--
GitLab