Skip to content

Commit 1b81908

Browse files
committed
DOC: Use numpydoc convention, not .rst
1 parent d158f50 commit 1b81908

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

nibabel/nifti1.py

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1765,17 +1765,18 @@ def __init__(self, dataobj, affine, header=None,
17651765
self._affine2header()
17661766
# Copy docstring
17671767
__init__.__doc__ = analyze.AnalyzeImage.__init__.__doc__ + '''
1768-
.. note:: If both a ``header`` and an ``affine`` are specified, and the
1769-
``affine`` does not match the affine that is in the ``header``,
1770-
the ``affine`` will be used, but the ``sform_code`` and
1771-
``qform_code`` fields in the header will be re-initialised to
1772-
their default values. This is performed on the basis that, if
1773-
you are changing the affine, you are likely to be changing the
1774-
space to which the affine is pointing. The :meth:`set_sform`
1775-
and :meth:`set_qform` methods can be used to update the codes
1776-
after an image has been created - see those methods, and
1777-
the :ref:`manual <default-sform-qform-codes>` for more details.
1778-
'''
1768+
Notes
1769+
-----
1770+
1771+
If both a ``header`` and an ``affine`` are specified, andq the ``affine``
1772+
does not match the affine that is in the ``header``, the ``affine`` will
1773+
be used, but the ``sform_code`` and ``qform_code`` fields in the header
1774+
will be re-initialised to their default values. This is performed on the
1775+
basis that, if you are changing the affine, you are likely to be changing
1776+
the space to which the affine is pointing. The :meth:`set_sform` and
1777+
:meth:`set_qform` methods can be used to update the codes after an image
1778+
has been created - see those methods, and the :ref:`manual
1779+
<default-sform-qform-codes>` for more details. '''
17791780

17801781

17811782
def update_header(self):

0 commit comments

Comments
 (0)