Skip to content

Commit e28397c

Browse files
committed
DOC: add deprecations to Changelog
From a suggestion by CM.
1 parent 3f5be38 commit e28397c

File tree

1 file changed

+39
-4
lines changed

1 file changed

+39
-4
lines changed

Changelog

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ New features
4242
* Add ability to write FreeSurfer morphology data (pr/414) (CM, BC, reviewed
4343
by BC);
4444
* Read and write support for DICOM tags in NIfTI Extended Header using
45-
pydicom (pr/296) (Eric Kastman);
45+
pydicom (pr/296) (Eric Kastman).
4646

4747
Enhancements
4848
------------
@@ -65,7 +65,7 @@ Enhancements
6565
* More explicit error when trying to read image from non-existent file
6666
(pr/455) (Ariel Rokem);
6767
* Extension to `nib-ls` command to show image statistics (pr/437) and other
68-
header files (pr/348) (Yarik Halchenko);
68+
header files (pr/348) (Yarik Halchenko).
6969

7070
Bug fixes
7171
---------
@@ -87,15 +87,50 @@ Maintenance
8787
* Various fixes for numpy, matplotlib, and PIL / Pillow compatibility (CM,
8888
Ariel Rokem, MB);
8989
* Improved test framework for warnings (pr/345) (BC, reviewed by CM, MB);
90+
* New decorator to specify start and end versions for deprecation warnings
91+
(MB, reviewed by CM).
9092

91-
API changes
92-
-----------
93+
API changes and deprecations
94+
----------------------------
9395

9496
* Minor API breakage in original (rather than new) trackvis reader. We are now
9597
raising a ``DataError`` if there are too few streamlines in the file,
9698
instead of a ``HeaderError``. We are raising a ``DataError`` if the track
9799
is truncated when ``strict=True`` (the default), rather than a ``TypeError``
98100
when trying to create the points array.
101+
* Deprecation of ``get_header``, ``get_affine`` method of image objects for
102+
removal in version 4.0;
103+
* Removed broken ``from_filespec`` method from image objects, and deprecated
104+
``from_filespec`` method of ECAT image objects for removal in 4.0;
105+
* Deprecation of ``class_map`` instance in ``imageclasses`` module in favor of
106+
new image class attributes, for removal in 4.0;
107+
* Deprecation of ``ext_map`` instance in ``imageclasses`` module in favor of
108+
new image loading API, for removal in 4.0;
109+
* Deprecation of ``Header`` class in favor of ``SpatialHeader``, for removal
110+
in 4.0;
111+
* Deprecation of ``BinOpener`` class in favor of more generic ``Opener``
112+
class, for removal in 4.0;
113+
* Deprecation of ``GiftiMetadata`` methods ``get_metadata`` and ``get_rgba``;
114+
``GiftiDataArray`` methods ``get_metadata``, ``get_labeltable``,
115+
``set_labeltable``; ``GiftiImage`` methods ``get_meta``, ``set_meta``. All
116+
these deprecated in favor of corresponding properties, for removal in 4.0;
117+
* Deprecation of ``giftiio`` ``read`` and ``write`` functions in favor of
118+
nibabel ``load`` and ``save`` functions, for removal in 4.0;
119+
* Deprecation of ``gifti.data_tag`` function, for removal in 4.0;
120+
* Deprecation of write-access to ``GiftiDataArray.num_dim``, and new error
121+
when trying to set invalid values for ``num_dim``. We will remove
122+
write-access in 4.0;
123+
* Deprecation of ``GiftiDataArray.from_array`` in favor of ``GiftiDataArray``
124+
constructor, for removal in 4.0;
125+
* Deprecation of ``GiftiDataArray`` ``to_xml_open, to_xml_close`` methods in
126+
favor of ``to_xml`` method, for removal in 4.0;
127+
* Deprecation of ``parse_gifti_fast.Outputter`` class in favor of
128+
``GiftiImageParser``, for removal in 4.0;
129+
* Deprecation of ``parse_gifti_fast.parse_gifti_file`` function in favor of
130+
``GiftiImageParser.parse`` method, for removal in 4.0;
131+
* Deprecation of ``loadsave`` functions ``guessed_image_type`` and
132+
``which_analyze_type``, in favor of new API where each image class tests the
133+
file for compatibility during load, for removal in 4.0;
99134

100135
2.0.2 (Monday 23 November 2015)
101136
===============================

0 commit comments

Comments
 (0)