Skip to content

Commit 539aeb3

Browse files
committed
Update the README
1 parent 2677b50 commit 539aeb3

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Execution of a Python code snippet: `print("hello")`
5454
```mermaid
5555
sequenceDiagram
5656
Frontend->>+Server: POST /api/kernels/<id>/execute
57-
Server->>+ExecutionStack: Create asyncio.Task
57+
Server->>+ExecutionStack: Queue request
5858
ExecutionStack->>Kernel: Execute request msg
5959
activate Kernel
6060
ExecutionStack-->>Server: Task uid
@@ -85,7 +85,7 @@ Execution of a Python code snippet: `input("Age:")`
8585
```mermaid
8686
sequenceDiagram
8787
Frontend->>+Server: POST /api/kernels/<id>/execute
88-
Server->>+ExecutionStack: Create asyncio.Task
88+
Server->>+ExecutionStack: Queue request
8989
ExecutionStack->>Kernel: Execute request msg
9090
activate Kernel
9191
ExecutionStack-->>Server: Task uid
@@ -122,6 +122,14 @@ sequenceDiagram
122122
Server-->>-Frontend: Status 200 & result
123123
```
124124

125+
> [!NOTE]
126+
> The code snippet is always send in the body of the POST `/api/kernels/<id>/execute`
127+
> request to avoid document model discrepancy; the document on the backend is only
128+
> eventually identical with the frontends (document updates are not instantaneous).
129+
>
130+
> The `ExecutionStack` maintains an execution queue per kernels to ensure execution
131+
> order.
132+
125133
## Contributing
126134

127135
### Development install

0 commit comments

Comments
 (0)