Added missing documentation for the inspectVariables request and resp… #649
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -1137,7 +1141,7 @@ In order to support page reloading, or a client connecting at a later stage, Jup | |||
| 'command' : 'debugInfo' | |||
| } | |||
|
|
|||
| Content of `debugInfo` response:: | |||
| Content of the `debugInfo` response:: | |||
There was a problem hiding this comment.
I think we should get rid of the two-space indentation here, and in other places too:
Suggested change
| Content of the `debugInfo` response:: | |
| Content of the `debugInfo` response:: |
There was a problem hiding this comment.
If you look at the generated doc, this allwos to easily identify the different messages added to the spec. I think we should either keep this indentation, or add subsections.
There was a problem hiding this comment.
add subsections
Yes maybe as a bullet list?
There was a problem hiding this comment.
Let's do this reformating part in a dedicated PR since the indentation was here before. We really need to move on and merge this one since we have more fields to add in some messages.
| @@ -1160,6 +1164,32 @@ In order to support page reloading, or a client connecting at a later stage, Jup | |||
|
|
|||
| The `source_breakpoint` schema is specified by the Debug Adapter Protocol. | |||
|
|
|||
| The `inspectVariables` is meant to retrieve the values of all the variables that have been defined in the notebook. It is a DAP `Request` with no extra argument. | |||
|
|
|||
| Content of the `inspectVariables` request:: | |||
| 'command' : 'inspectVariables' | ||
| } | ||
|
|
||
| Content of the `inspectVariables` response:: |
jtpio
reviewed
May 28, 2021
Co-authored-by: Jeremy Tuloup <jeremy.tuloup@gmail.com>
davidbrochart
approved these changes
Jun 4, 2021
|
Thanks @davidbrochart ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…onse
Notice that this is not a new message to the protocol, but missing documentation for a message the has been part of the debugging protocol in Jupyter since the beginning.