Skip to content

Commit 672d1a0

Browse files
committed
add some docstrings
1 parent 4e37641 commit 672d1a0

File tree

3 files changed

+22
-3
lines changed

3 files changed

+22
-3
lines changed

nipype/interfaces/base/specs.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
11
# -*- coding: utf-8 -*-
22
# emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
33
# vi: set ft=python sts=4 ts=4 sw=4 et:
4+
"""
5+
6+
Base I/O specifications for Nipype interfaces
7+
.............................................
8+
9+
Define the API for the I/O of interfaces
10+
11+
"""
412
from __future__ import print_function, division, unicode_literals, absolute_import
513

614
import os
715
from copy import deepcopy
8-
from packaging.version import Version
916
from warnings import warn
1017
from builtins import str, bytes
18+
from packaging.version import Version
1119

1220
from ...utils.misc import is_container
1321
from ...utils.filemanip import md5, hash_infile, hash_timestamp, to_str
@@ -23,7 +31,8 @@
2331

2432

2533
class BaseTraitedSpec(traits.HasTraits):
26-
"""Provide a few methods necessary to support nipype interface api
34+
"""
35+
Provide a few methods necessary to support nipype interface api
2736
2837
The inputs attribute of interfaces call certain methods that are not
2938
available in traits.HasTraits. These are provided here.

nipype/interfaces/base/support.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# -*- coding: utf-8 -*-
22
# emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
33
# vi: set ft=python sts=4 ts=4 sw=4 et:
4+
"""
5+
6+
Miscelanous tools to support Interface functionality
7+
....................................................
8+
9+
"""
410
from __future__ import print_function, division, unicode_literals, absolute_import
511
from builtins import range, object, open, str
612

nipype/interfaces/base/traits_extension.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# -*- coding: utf-8 -*-
22
# emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
33
# vi: set ft=python sts=4 ts=4 sw=4 et:
4-
"""This module contains Trait classes that we've pulled from the
4+
"""
5+
Traits extention
6+
................
7+
8+
This module contains Trait classes that we've pulled from the
59
traits source and fixed due to various bugs. File and Directory are
610
redefined as the release version had dependencies on TraitsUI, which
711
we do not want Nipype to depend on. At least not yet.

0 commit comments

Comments
 (0)