Skip to content

docs(execution): describe Cancel as the way to stop a run - #6

Merged
0xmhha merged 1 commit into
mainfrom
docs/cancel-comment
Oct 29, 2026
Merged

0xmhha merged 1 commit into
mainfrom
docs/cancel-comment

Conversation

@0xmhha

@0xmhha 0xmhha commented Oct 29, 2026

Copy link
Copy Markdown
Member

Summary

The ExecutionService comments in execution.proto were out of date:

  • They said that closing the Run stream cancels the run.
  • They described Cancel as a call made from another tab.

Since #4, a run outlives its stream once Accepted has been sent. The comments now say that Cancel is how a client stops a run, and that ResumeRun is how it reattaches to the output.

Testing

  • buf lint and buf generate pass.
  • The generated code changes only in its doc comments (execution.connect.go, execution_pb.ts).

Not verified

Nothing applies: the change touches comments only.

The service comments still said that closing the Run stream cancels the run and that Cancel was for other tabs. Since runs outlive their stream after Accepted, describe Cancel as how a client stops a run and ResumeRun as how it reattaches. Comment-only change; generated code is regenerated.
@0xmhha
0xmhha merged commit 1f1e743 into main Oct 29, 2026
2 checks passed
@0xmhha
0xmhha deleted the docs/cancel-comment branch October 29, 2026 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant