Skip to content

Commit 3387f42

Browse files
committed
doc: added version config info to doc
1 parent 35781be commit 3387f42

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

doc/devel/interface_specs.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -269,9 +269,9 @@ Common
269269
performed at runtime.::
270270

271271
class RealignInputSpec(BaseInterfaceInputSpec):
272-
jobtype = traits.Enum('estwrite', 'estimate', 'write', min_ver=5,
272+
jobtype = traits.Enum('estwrite', 'estimate', 'write', min_ver='5',
273273
usedefault=True)
274-
``deprecated``
274+
``deprecated`` and ``new_name``
275275
This is metadata for removing or renaming an input field from a spec.::
276276

277277
class RealignInputSpec(BaseInterfaceInputSpec):
@@ -285,7 +285,6 @@ Common
285285
from current release. Raises `TraitError` after package version crosses the
286286
deprecation version.
287287

288-
``new_name``
289288
For inputs that are being renamed, one can specify the new name of the
290289
field.::
291290

@@ -302,6 +301,11 @@ Common
302301
When `new_name` is provided it must exist as a trait, otherwise an exception
303302
will be raised.
304303

304+
.. note::
305+
306+
The version information for `min_ver`, `max_ver` and `deprecated` has to be
307+
provided as a string. For example, `min_ver='0.1'`.
308+
305309
CommandLine
306310
^^^^^^^^^^^
307311

doc/users/config_file.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,11 @@ Execution
109109
data through (without copying) (possible values: ``true`` and
110110
``false``; default value: ``false``)
111111

112+
*stop_on_unknown_version*
113+
If this is set to True, an underlying interface will raise an error, when no
114+
version information is available. Please notify developers or submit a
115+
patch.
116+
112117
Example
113118
~~~~~~~
114119

0 commit comments

Comments
 (0)