Skip to content

Commit 9429806

Browse files
committed
fix: resolved conflicts
2 parents 1c9ee90 + c0ab47c commit 9429806

File tree

9 files changed

+6343
-13
lines changed

9 files changed

+6343
-13
lines changed

CHANGES

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Next release
77
how to set SGE specific options (smri_ants_build_template_new)
88
* ENH: added no_flatten option to Merge
99
* ENH: added versioning option and checking to traits
10+
* ENH: added deprecation metadata to traits
1011

1112
Release 0.6.0 (Jun 30, 2012)
1213
============================

doc/devel/interface_specs.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,36 @@ Common
271271
class RealignInputSpec(BaseInterfaceInputSpec):
272272
jobtype = traits.Enum('estwrite', 'estimate', 'write', min_ver=5,
273273
usedefault=True)
274+
``deprecated``
275+
This is metadata for removing or renaming an input field from a spec.::
276+
277+
class RealignInputSpec(BaseInterfaceInputSpec):
278+
jobtype = traits.Enum('estwrite', 'estimate', 'write',
279+
deprecated='0.8',
280+
desc='one of: estimate, write, estwrite',
281+
usedefault=True)
282+
283+
In the above example this means that the `jobtype` input is deprecated and
284+
will be removed in version 0.8. Deprecation should be set to two versions
285+
from current release. Raises `TraitError` after package version crosses the
286+
deprecation version.
287+
288+
``new_name``
289+
For inputs that are being renamed, one can specify the new name of the
290+
field.::
291+
292+
class RealignInputSpec(BaseInterfaceInputSpec):
293+
jobtype = traits.Enum('estwrite', 'estimate', 'write',
294+
deprecated='0.8', new_name='job_type',
295+
desc='one of: estimate, write, estwrite',
296+
usedefault=True)
297+
job_type = traits.Enum('estwrite', 'estimate', 'write',
298+
desc='one of: estimate, write, estwrite',
299+
usedefault=True)
300+
301+
In the above example, the `jobtype` field is being renamed to `job_type`.
302+
When `new_name` is provided it must exist as a trait, otherwise an exception
303+
will be raised.
274304

275305
CommandLine
276306
^^^^^^^^^^^

doc/index.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
.. admonition:: Announcement
2-
3-
Nipype Connectivity Workshop 2012 in Magdeburg, Germany: Sep 8-9, 2012:
4-
`Information and Registration`__
5-
6-
__ http://nipype.blogspot.com
7-
81
.. list-table::
92

103
* - .. image:: images/nipype_architecture_overview2.png

0 commit comments

Comments
 (0)