Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify Kino.interrupt!/2 usage #334

Merged
merged 2 commits into from
Sep 7, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions lib/kino.ex
Original file line number Diff line number Diff line change
Expand Up @@ -487,9 +487,12 @@ defmodule Kino do
Interrupts evaluation with the given message.

This function raises a specific error to let Livebook known that
evaluation should be stopped. The error message is shown to the
user and they can retry evaluation with a button click, supposedly
after they resolve the interrupt reason.
evaluation should be stopped. The error message and a `Continue`
button are shown to the user, who can then attempt to resolve the
source of the interrupt before resuming execution.

user who, after resolving resolving the source of the issue, can
retry evaluation with a button click
jonatanklosko marked this conversation as resolved.
Show resolved Hide resolved

> #### Do not use interrupt inside listeners {: .warning}
>
Expand Down