diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ba246c946dc9f9cb16ed9b67adba77b3e133e8d1..ab5db7f35b06d1a05f4a921be4517f00167fc52e 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -169,7 +169,7 @@ Added * Simple built-in :mod:`.deprecated` decorator. * New :mod:`fsl.data.utils` module, which currently contains one function :func:`.guessType`, which guesses the data type of a file/directory path. -* New `.commonBase` function for finding the common prefix of a set of +* New :func:`.commonBase` function for finding the common prefix of a set of file/directory paths. @@ -209,7 +209,7 @@ Fixed ^^^^^ -* Fixed an issue with the `.dicom.loadSeries` using memory-mapping for +* Fixed an issue with the :func:`.dicom.loadSeries` using memory-mapping for image files that would subsequently be deleted. * Fixed an issue in the :class:`.GiftiMesh` class, where ``numpy``/``nibabel`` was returning read-only index arrays. diff --git a/doc/contributing.rst b/doc/contributing.rst index 4e76856b7505fe98a204090b96afa0dcb6cd825a..ef710683b31c8094be90fe39a44d85d2e3e20be4 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -34,7 +34,7 @@ the following labels (this convention has been inherited from `nibabel * *BF* : bug fix * *RF* : refactoring - * *NF* : new feature + * *ENH*: enhancement/new feature * *BW* : addresses backward-compatibility * *OPT* : optimization * *BK* : breaks something and/or tests fail @@ -102,7 +102,7 @@ Unit and integration tests are currently run with ``py.test`` and ``coverage``. - Aim for 100% code coverage. -- Tests must pass on python 2.7, 3.4, 3.5, and 3.6 +- Tests must pass on python 3.5, 3.6, and 3.7. Coding conventions