Skip to content

Document interrupt-key split in /help and NEWS#82

Merged
TroyHernandez merged 1 commit into
mainfrom
doc-interrupt-keys
May 14, 2026
Merged

Document interrupt-key split in /help and NEWS#82
TroyHernandez merged 1 commit into
mainfrom
doc-interrupt-keys

Conversation

@TroyHernandez
Copy link
Copy Markdown
Contributor

Summary

  • The interrupt-key path splits by environment but the docs didn't say so. Add a Keys: section to both /help outputs and tighten the NEWS bullet.
  • RStudio console + corteza::chat(): Esc only — RStudio swallows Ctrl+C for clipboard copy.
  • Terminal ~/bin/corteza: Ctrl+C only — terminals send a raw ^[ byte for Esc, not a signal.

Earlier NEWS implied Esc worked in both and Ctrl+C was a CLI-only fallback. Wrong on both counts; each environment has exactly one usable key and they don't overlap. Troy caught this on a smoke test.

Test plan

  • corteza::chat()/help. Confirm new Keys: section reads correctly.
  • corteza --help. Same.

Notes

Making terminal Esc into a SIGINT is doable (raw mode + bare-ESC timeout disambiguation so arrow-key sequences don't kill the process) but a separate project — filed for the QOL list, not in scope here.

The interrupt key splits cleanly by environment but neither path's
/help mentioned it: RStudio console + corteza::chat() uses Esc (RStudio
swallows Ctrl+C for clipboard copy), while the terminal ~/bin/corteza
CLI uses Ctrl+C (terminals send a raw ^[ byte for Esc, which is not a
signal). NEWS originally implied Esc works in both environments and
Ctrl+C falls back to the CLI; reality is that each environment has
exactly one usable interrupt key and they don't overlap.

Add a Keys: section to both /help outputs and tighten the NEWS bullet.
@TroyHernandez TroyHernandez merged commit fbe700d into main May 14, 2026
4 checks passed
@TroyHernandez TroyHernandez deleted the doc-interrupt-keys branch May 14, 2026 18:43
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