1
0
forked from VimPlug/jedi

Merge pull request #709 from davidhalter/debug-docs

Enhance docs about debugging
This commit is contained in:
Dave Halter
2016-03-21 11:30:05 +01:00

View File

@@ -3,6 +3,9 @@ The API basically only provides one class. You can create a :class:`Script` and
use its methods.
Additionally you can add a debug function with :func:`set_debug_function`.
Alternatively, if you don't need a custom function and are happy with printing
debug messages to stdout, simply call :func:`set_debug_function` without
arguments.
.. warning:: Please, note that Jedi is **not thread safe**.
"""
@@ -722,6 +725,8 @@ def set_debug_function(func_cb=debug.print_to_stdout, warnings=True,
"""
Define a callback debug function to get all the debug messages.
If you don't specify any arguments, debug messages will be printed to stdout.
:param func_cb: The callback function for debug messages, with n params.
"""
debug.debug_function = func_cb