Fixes #3849. Docs: clarify when to use -ing vs -ed events (Accepting vs Accepted, etc.)#5298
Merged
Merged
Conversation
…etc.) Agent-Logs-Url: https://github.com/gui-cs/Terminal.Gui/sessions/88118443-40e0-48dd-bac0-a78e90ec1b12 Co-authored-by: tig <585482+tig@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Docs: clarify when to use -ing vs -ed events
Fixes #3849. Docs: clarify when to use May 12, 2026
-ing vs -ed events (Accepting vs Accepted, etc.)
tig
approved these changes
May 12, 2026
BDisp
approved these changes
May 12, 2026
This was referenced May 21, 2026
This was referenced May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
AI agents and IntelliSense autocomplete consistently reach for
-ingevents (Accepting,Activating) for simple side-effect handlers that should use-edevents instead. The-ingvariants run synchronously mid-dispatch and are cancellable — subscribing without cancelling is both wasteful and misleading.Changes
docfx/docs/events.md— New "When to Use-ingvs-edEvents" section added near the top with the canonical rule, concrete ✅/❌ examples, and a quick-reference table covering all common pairs..claude/rules/event-patterns.md— Same rule added as the first section so Copilot/Claude sees it immediately when reading event guidance.View.Command.csXML docs —<remarks>added to all four paired command events:Accepting/AcceptedActivating/ActivatedRule (now in docs, xmldoc, and AI rules)
Pull Request checklist:
CTRL-K-Dto automatically reformat your files before committing.dotnet testbefore commit///style comments)