From 39b5961314019055756069b58da3e8d287c5b258 Mon Sep 17 00:00:00 2001 From: Paul McCarthy <pauldmccarthy@gmail.com> Date: Thu, 11 Apr 2019 17:06:21 +0100 Subject: [PATCH] DOC: fixes to contributing guide and changelog --- CHANGELOG.rst | 4 ++-- doc/contributing.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index ba246c946..ab5db7f35 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 4e76856b7..ef710683b 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 -- GitLab