Skip to content

docs(getting-started): use Accepted for side effects (canonical rule) - #5534

Merged
tig merged 1 commit into
developfrom
docs/getting-started-accepted
Jun 23, 2026
Merged

tig merged 1 commit into
developfrom
docs/getting-started-accepted

Conversation

@tig

@tig tig commented Jun 23, 2026

Copy link
Copy Markdown
Member

Cascade of the maintainer ruling that Accepted is canonical for side effects (Accepting only to cancel).

getting-started.md said "event handling uses the Accepting event", which contradicts the rule. Reworded to:

  • Use Accepted for side effects (e.g. handling a button press); the legacy Accept event is gone.
  • Use Accepting only to inspect or cancel an action (e.Handled = true).

Both are public events on View (ViewBase/View.Command.cs), so the xrefs resolve.

Part of #5525. (Companion: the templates were aligned in tui-cs/Terminal.Gui.templates#38. The cookbook examples were checked and are already correct — they use Accepting with e.Handled for genuine validation/cancel.)

Maintainer ruling: Accepted is canonical for side effects; Accepting only to cancel.
getting-started.md said 'event handling uses the Accepting event', contradicting that.
Reword to: use Accepted for side effects (button presses); use Accepting only to
inspect/cancel (e.Handled = true). Both are public events on View; xrefs resolve.

Part of #5525.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@tig
tig merged commit b017eb0 into develop Jun 23, 2026
@tig
tig deleted the docs/getting-started-accepted branch June 23, 2026 20:39
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