@@ -31,7 +31,7 @@ def to_header(axes):
3131
3232 Parameters
3333 ----------
34- axes : iterable[ Axis]
34+ axes : iterable of :py:class:` Axis` objects
3535 one or more axes describing each dimension in turn
3636
3737 Returns
@@ -140,10 +140,10 @@ def __init__(self, name, voxel=None, vertex=None, affine=None,
140140 affine : np.ndarray
141141 (4, 4) array mapping voxel indices to mm space (not needed for CIFTI files only
142142 covering the surface)
143- volume_shape : Tuple[int, int, int]
143+ volume_shape : tuple of three integers
144144 shape of the volume in which the voxels were defined (not needed for CIFTI files only
145145 covering the surface)
146- nvertices : dict[String -> int]
146+ nvertices : dict from string to integer
147147 maps names of surface elements to integers (not needed for volumetric CIFTI files)
148148 """
149149 if voxel is None :
@@ -361,7 +361,7 @@ def to_cifti_brain_structure_name(name):
361361
362362 Parameters
363363 ----------
364- name: (str, tuple)
364+ name: iterable of 2-element tuples of integer and string
365365 input name of an anatomical region
366366
367367 Returns
@@ -598,7 +598,7 @@ def __init__(self, name, voxels, vertices, affine=None, volume_shape=None, nvert
598598 affine : np.ndarray
599599 (4, 4) array mapping voxel indices to mm space (not needed for CIFTI files only
600600 covering the surface)
601- volume_shape : Tuple[int, int, int]
601+ volume_shape : tuple of three integers
602602 shape of the volume in which the voxels were defined (not needed for CIFTI files only
603603 covering the surface)
604604 nvertices : dict[String -> int]
@@ -634,7 +634,7 @@ def from_brain_models(cls, named_brain_models):
634634
635635 Parameters
636636 ----------
637- named_brain_models : List[Tuple[String, BrainModel]]
637+ named_brain_models : iterable of 2-element tuples of string and BrainModel
638638 list of (parcel name, brain model representation) pairs defining each parcel
639639
640640 Returns
@@ -889,9 +889,9 @@ def __init__(self, name, meta=None):
889889 """
890890 Parameters
891891 ----------
892- name : np.ndarray
892+ name : np.ndarray of string
893893 (N, ) string array with the parcel names
894- meta : np.ndarray
894+ meta : np.ndarray of dict
895895 (N, ) object array with a dictionary of metadata for each row/column.
896896 Defaults to empty dictionary
897897 """
0 commit comments