Clarify documentation of IChangeToken.ActiveChangeCallbacks#126640
Open
svick wants to merge 1 commit intodotnet:mainfrom
Open
Clarify documentation of IChangeToken.ActiveChangeCallbacks#126640svick wants to merge 1 commit intodotnet:mainfrom
svick wants to merge 1 commit intodotnet:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR clarifies the documentation contract around IChangeToken.ActiveChangeCallbacks, specifically addressing scenarios (like CompositeChangeToken) where ActiveChangeCallbacks == true doesn’t imply that every underlying change will reliably trigger callbacks.
Changes:
- Updates
IChangeToken.ActiveChangeCallbacksXML docs to better describe consumer expectations and accuracy considerations. - Adds/expands
CompositeChangeTokendocumentation to describe how inner tokens with/without active callbacks affect callback propagation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/libraries/Microsoft.Extensions.Primitives/src/IChangeToken.cs | Refines the interface-level docs for ActiveChangeCallbacks and adds remarks about accuracy expectations. |
| src/libraries/Microsoft.Extensions.Primitives/src/CompositeChangeToken.cs | Documents CompositeChangeToken callback propagation behavior and clarifies ActiveChangeCallbacks meaning for composites. |
src/libraries/Microsoft.Extensions.Primitives/src/CompositeChangeToken.cs
Show resolved
Hide resolved
rosebyte
approved these changes
Apr 8, 2026
tarekgh
approved these changes
Apr 8, 2026
Member
tarekgh
left a comment
tarekgh
left a comment
There was a problem hiding this comment.
LGTM!
CC @KalleOlaviNiemitalo if has any feedback.
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.
Resolves #40677.
In particular, see the explanation at #40677 (comment).