Skip to content

Commit 385197b

Browse files
committed
🎨 Add newlines in nodes developer doc
1 parent 3a899f7 commit 385197b

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/_sources/developer/nodes.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,12 @@ When a developer creates or modifies a Node in C-PAC, a ``mem_gb`` and ``n_procs
2222

2323
For nodes that will use a varying amount of memory depending on the node's input data, the optional parameter ``mem_x`` takes a tuple of ``(memory multiplier, input file, multiplier mode)`` where ``memory multiplier`` is a number and ``input file`` is the string name of the Node input to multiply such that the memory estimate returned by the ``mem_gb`` attribute is the ``mem_gb`` argument plus ``memory multiplier`` times the dimensions of the ``input file`` as specified in the ``multiplier mode`` (``xyzt`` (spatial × temporal; default), ``xyz`` (spatial), or just ``t`` (temporal)).
2424

25+
2526
.. note::
2627
``mem_x`` is a new parameter in C-PAC v1.8.1 and subject to change in future releases as we continue to `develop methods for setting data- and operation-dependent memory estimates <https://github.com/FCP-INDI/C-PAC/issues/1509>`_.
2728

2829

30+
2931
.. autoclass:: CPAC.pipeline.nipype_pipeline_engine.Node
3032
:special-members: __init__
3133
:members:
@@ -41,10 +43,14 @@ For nodes that will use a varying amount of memory depending on the node's input
4143
:members:
4244
:inherited-members:
4345

46+
47+
4448
.. seealso::
4549

4650
`Nipype: Interface Specifications <https://nipype.readthedocs.io/en/1.5.1/devel/interface_specs.html>`_
4751

52+
53+
4854
.. autoclass:: CPAC.utils.interfaces.function.Function
4955
:special-members: __init__
5056
:members:

0 commit comments

Comments
 (0)