Skip to content

Commit 10e1303

Browse files
committed
⚗️ Indent note and seealso
1 parent cddc8d1 commit 10e1303

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

docs/_sources/developer/nodes.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,9 @@ When a developer creates or modifies a Node in C-PAC, a ``mem_gb`` and ``n_procs
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

2525

26-
.. note::
27-
``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>`_.
26+
.. note::
27+
``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>`_.
2828

29-
---
3029

3130
.. autoclass:: CPAC.pipeline.nipype_pipeline_engine.Node
3231
:special-members: __init__
@@ -44,11 +43,9 @@ For nodes that will use a varying amount of memory depending on the node's input
4443
:inherited-members:
4544

4645

46+
.. seealso::
47+
`Nipype: Interface Specifications <https://nipype.readthedocs.io/en/1.5.1/devel/interface_specs.html>`_
4748

48-
.. seealso::
49-
`Nipype: Interface Specifications <https://nipype.readthedocs.io/en/1.5.1/devel/interface_specs.html>`_
50-
51-
----
5249

5350
.. autoclass:: CPAC.utils.interfaces.function.Function
5451
:special-members: __init__
@@ -60,12 +57,13 @@ For nodes that will use a varying amount of memory depending on the node's input
6057
:members:
6158
:inherited-members:
6259

60+
6361
The Nipype utility function :py:func:`~nipype.utils.draw_gantt_chart.log_to_dict` reads a log file generated by ``log_nodes_cb`` to a Python dictionary.
6462

63+
6564
.. autofunction:: CPAC.utils.monitoring.log_nodes_cb
6665

67-
draw_gantt_chart
68-
================
66+
6967

7068
.. automodule:: CPAC.utils.monitoring.draw_gantt_chart
7169
:members: resource_report, log_to_dict, generate_gantt_chart, resource_overusage_report

0 commit comments

Comments
 (0)