Browse Source

Update description

Afshin T. Darian 5 years ago
parent
commit
fcd8f299cf
1 changed files with 4 additions and 1 deletions
  1. 4 1
      tests/src/design.md

+ 4 - 1
tests/src/design.md

@@ -2,8 +2,11 @@
 
 - The debugger UI will only ever exist as a single instance within JupyterLab:
   - An expanded mode which is a `MainAreaWidget<Debugger>`
-  - A collapsed mode which is a condensed sidebar view of the debugger within the `right` or `left` areas of the JupyterLab shell
+  - A condensed mode which is a condensed sidebar view of the debugger within the `right` or `left` areas of the JupyterLab shell
 - The debugger will support debugging and inspecting environment three types of activities in JupyterLab:
   1. Notebooks
   1. Code consoles
   1. Text editors that are backed by a kernel
+- A `JupyterFrontendPlugin` will exist to track each of the activities and each time the `currentChanged` signal fires on one of the trackers, the debugger UI will reflect the state of that activity, e.g.:
+  - If a user has a single open notebook and opens the debugger, it will open either "docked" in the sidebar or in the main area depending on the last known position of the debugger.
+  - If the user then opens a new notebook or switches to a code console, then the debugger will update to show the state of the newly focused kernel.