diff --git a/docs/messaging.rst b/docs/messaging.rst index 21c3698c3..5df8ecd29 100644 --- a/docs/messaging.rst +++ b/docs/messaging.rst @@ -1190,6 +1190,32 @@ The `inspectVariables` is meant to retrieve the values of all the variables that } } +The ``richInspectVariables`` request allows to get the rich representation of a variable that has been defined in the kernel. + + Content of the ``richInspectVariables`` request:: + + { + 'type' : 'request', + 'command' : 'richInspectVariables', + 'arguments' : { + 'variableName' : str, + # The frameId is used when the debugger hit a breakpoint only. + 'frameId' : int + } + } + + Content of the ``richInspectVariables`` response:: + + { + 'type' : 'response', + 'success' : bool, + 'body' : { + # Dictionary of rich reprensentations of the variable + 'data' : dict, + 'metadata' : dict + } + } + .. versionadded:: 5.5 Messages on the IOPub (PUB/SUB) channel