Skip to content

docs(core): document builtin worker invariant - #12

Merged
cataggar merged 1 commit into
kfrom
docs/issue-10-builtin-worker-invariant
Aug 20, 2026
Merged

cataggar merged 1 commit into
kfrom
docs/issue-10-builtin-worker-invariant

Conversation

@cataggar

Copy link
Copy Markdown
Owner

Summary

  • document that builtins commonly run inline on a runtime worker
  • warn against blocking that worker on file-descriptor reads
  • link builtin authors to openfiles::without_parking_worker

Validation

  • cargo fmt --check --all
  • cargo test --package brush-core --doc

Closes #10

@cataggar
cataggar changed the base branch from main to k August 19, 2026 19:13
@cataggar
cataggar force-pushed the docs/issue-10-builtin-worker-invariant branch from 512a7e2 to 8c6a201 Compare August 19, 2026 19:13
Assisted-by: GitHub Copilot CLI:gpt-5.6-sol
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@cataggar
cataggar force-pushed the docs/issue-10-builtin-worker-invariant branch from 8c6a201 to f791315 Compare August 19, 2026 19:48
@cataggar
cataggar merged commit e0916ac into k Aug 20, 2026
37 of 38 checks passed
@cataggar
cataggar deleted the docs/issue-10-builtin-worker-invariant branch August 20, 2026 01:59
cataggar added a commit that referenced this pull request Aug 22, 2026
Assisted-by: GitHub Copilot CLI:gpt-5.6-sol

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

Docs: state the 'builtins must not block a runtime worker' invariant where builtin authors will see it

1 participant