Commit f3f75cc3 authored by Paul McCarthy's avatar Paul McCarthy 🚵
Browse files

Include changelog in docs

parent b963fa31
``fslpy`` release history
==========================
This document contains the ``fslpy`` release history in reverse chronological
order.
1.3.0 (under development)
......@@ -26,7 +26,7 @@
1.2.1 (Saturday October 7th 2017)
---------------------------------
*
* If an :class:`.Image` is passed an existing ``nibabel`` header object,
it creates a copy, rather than using the original.
* New :meth:`.Image.resample` method, which resamples the image data to a
......@@ -43,7 +43,7 @@
* :meth:`fsl.data.image.Nifti.voxelsToScaledVoxels` method deprecated in
favour of new :meth:``.Nifti.voxToScaledVoxMat` and
favour of new :meth:`.Nifti.voxToScaledVoxMat` and
:meth:`Nifti.scaledVoxToVoxMat` properties.
......@@ -65,16 +65,18 @@
* New functions and further adjustments in :mod:`fsl.utils.transform` module:
- :func:`.transform.rotMatToAffine` converts a ``(3, 3)`` rotation matrix
into a ``(4, 4)`` affine.
- :func:`.transform.transformNormal` applies an affine transform to one or
more vectors.
- :func:`.transform.veclength` calculates the length of a vector
- :func:`.transform.normalise` normalises a vector
- :func:`.transform.scaleOffsetXform` adjusted to have more flexibility with
respect to inputs.
- :func:`.transform.decompose` can return rotations either as three
axis-angles, or as a rotation matrix
- :func:`.transform.rotMatToAffine` converts a ``(3, 3)`` rotation matrix
into a ``(4, 4)`` affine.
- :func:`.transform.transformNormal` applies an affine transform to one or
more vectors.
- :func:`.transform.veclength` calculates the length of a vector
- :func:`.transform.normalise` normalises a vector
- :func:`.transform.scaleOffsetXform` adjusted to have more flexibility with
respect to inputs.
- :func:`.transform.decompose` can return rotations either as three
axis-angles, or as a rotation matrix
* Updates to :class:`fsl.data.mesh.TriangleMesh` - ``vertices`` and ``indices``
are now ``property`` attributes. New lazily generated ``normals`` and
``vnormals`` properties (face and vertex normals respectively). Option
......
``fslpy`` release history
=========================
.. include:: ../CHANGELOG.rst
......@@ -61,7 +61,7 @@ components of the release version number (see above). For example, the branch
name for minor release ``1.0`` would be ``v1.0``.
Patches and bugfixes may be added to these release branches as ``point``
Patches and bugfixes may be added to these release branches as ``patch``
releases. These changes should be made on the master branch like any other
change (i.e. via merge requests), and then cherry-picked onto the relevant
release branch(es).
......@@ -69,7 +69,7 @@ release branch(es).
Every release commit is also tagged with its full version number. For
example, the first release off the ``v1.0`` branch would be tagged with
``1.0.0``. Point releases to the ``v1.0`` branch would be tagged with
``1.0.0``. Patch releases to the ``v1.0`` branch would be tagged with
``1.0.1``, ``1.0.2``, etc.
......@@ -124,10 +124,11 @@ for a list of error codes):
- E303: too many blank lines (3)
- E701: multiple statements on one line (colon)
The ``pylint`` tool checks many of the same things as ``flake8`,` and can be
*very* opinionated about other things. So I disable all refactoring and
convention messages, and a few select warnings (type ``pylint --list-msgs``
for a full list of codes):
The ``pylint`` tool can be *very* opinionated about how you write your code,
and also checks many of the same things as ``flake8``. So I disable all
refactoring and convention messages, and a few select warnings (type ``pylint
--list-msgs`` for a full list of codes):
- W0511 (``fixme``): Warn about ``TODO`` and ``FIXME`` comments
......
......@@ -12,3 +12,4 @@ by |fsleyes_apidoc|_.
self
fsl
contributing
changelog
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment