Changeset 1558 for trunk/config_example.py

Timestamp:

Nov 2, 2014 10:11:53 PM (8 years ago)

Author:

toby

Message:

add some debug options with pdb and IPython

File:

• trunk/config_example.py (modified) (1 diff)

trunk/config_example.py

@@ -16 +16 @@
 provide the default behavior if the file is not present or if any configuration
 variable is not set, but please do place a docstring here for every used
-config variable explaining what it does. 
+config variable explaining what it does. Access these variables using
+:func:`GSASIIpath.GetConfigValue`.
+'''
+
+debug = False
+'''Set to True to turn on debugging mode. This enables use of IPython on 
+exceptions and on calls to :func:`GSASIIpath.IPyBreak`. Calls to
+:func:`GSASIIpath.pdbBreak` will invoke pdb at that location.
+If debug is false calls to :func:`GSASIIpath.IPyBreak` and
+:func:`GSASIIpath.pdbBreak` are ignored.
 '''