Skip to content

Commit 785bdf4

Browse files
committed
DOC: Update documentation
1 parent b41d96b commit 785bdf4

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

doc/users/config_file.rst

+9-2
Original file line numberDiff line numberDiff line change
@@ -237,16 +237,23 @@ Debug configuration
237237

238238
To enable debug mode, one can insert the following lines::
239239

240-
from nipype import config, logging
240+
from nipype import config
241241
config.enable_debug_mode()
242-
logging.update_logging(config)
243242

244243
In this mode the following variables are set::
245244

246245
config.set('execution', 'stop_on_first_crash', 'true')
247246
config.set('execution', 'remove_unnecessary_outputs', 'false')
247+
config.set('execution', 'keep_inputs', 'true')
248248
config.set('logging', 'workflow_level', 'DEBUG')
249249
config.set('logging', 'interface_level', 'DEBUG')
250+
config.set('logging', 'utils_level', 'DEBUG')
251+
252+
The primary loggers (``workflow``, ``interface`` and ``utils``) are also reset
253+
to level ``DEBUG``.
254+
You may wish to adjust these manually using::
250255

256+
from nipype import logging
257+
logging.getLogger(<logger>).setLevel(<level>)
251258

252259
.. include:: ../links_names.txt

doc/users/debug.rst

+8-6
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,17 @@ performance issues.
2020
from nipype import config
2121
config.enable_debug_mode()
2222

23-
as the first import of your nipype script. To enable debug logging use::
24-
25-
from nipype import logging
26-
logging.update_logging(config)
23+
as the first import of your nipype script.
2724

2825
.. note::
2926

30-
Turning on debug will rerun your workflows and will rerun them after debugging
31-
is turned off.
27+
Turning on debug will rerun your workflows and will rerun them after
28+
debugging is turned off.
29+
30+
Turning on debug mode will also override log levels specified elsewhere,
31+
such as in the nipype configuration.
32+
``workflow``, ``interface`` and ``utils`` loggers will all be set to
33+
level ```DEBUG``.
3234

3335
#. There are several configuration options that can help with debugging. See
3436
:ref:`config_file` for more details::

0 commit comments

Comments
 (0)