Skip to content

Commit 9e1e601

Browse files
authored
Merge pull request #815 from yarikoptic/enh-doc
Improve formatting in custom_seqinfo doc + provide url to an example
2 parents 86c61d3 + 1e6961e commit 9e1e601

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/heuristics.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,9 +129,14 @@ to be used in ``infotodict``.
129129
Importantly the return value of that function needs to be hashable.
130130
For instance the following non-hashable types can be converted to an alternative
131131
hashable type:
132-
- list > tuple
133-
- dict > frozendict
134-
- arrays > bytes (tobytes(), or pickle.dumps), str or tuple of tuples.
132+
133+
- `list` --> `tuple`
134+
- `dict` --> `frozendict`
135+
- `arrays` --> `bytes` (`tobytes()`, or `pickle.dumps`), `str` or `tuple` of tuples.
136+
137+
For an example see
138+
`convertall_custom.py <https://github.com/nipy/heudiconv/blob/master/heudiconv/heuristics/convertall_custom.py#L16>`__
139+
heuristic.
135140

136141
-------------------------------
137142
``POPULATE_INTENDED_FOR_OPTS``

0 commit comments

Comments
 (0)