Add XML docs and usage examples to public interfaces #4233
Merged
+530
−71
Conversation
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
Enhanced XML documentation for key ReactiveUI interfaces and classes, including remarks and code examples. Improves discoverability and developer experience by clarifying usage patterns for activation, routing, interaction, suspension, and view binding APIs.
glennawatson
approved these changes
Dec 17, 2025
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4233 +/- ##
==========================================
+ Coverage 32.07% 40.33% +8.25%
==========================================
Files 146 146
Lines 6653 6655 +2
Branches 1024 1025 +1
==========================================
+ Hits 2134 2684 +550
+ Misses 4347 3779 -568
- Partials 172 192 +20 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request enhances XML documentation across ReactiveUI's core interfaces and classes by adding comprehensive remarks sections and practical code examples. The changes improve developer experience by clarifying usage patterns for activation, routing, interactions, suspension, and view binding APIs without modifying any functional code.
Key changes:
- Added detailed remarks sections explaining when and how to use key ReactiveUI interfaces
- Included practical code examples wrapped in CDATA sections demonstrating typical usage patterns
- Improved existing XML summaries for better clarity and consistency
Reviewed changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
SuspensionHost.cs |
Added remarks explaining the suspension host's role and usage example |
RoutingState.cs |
Enhanced documentation with navigation example and improved command descriptions |
RoutedViewHost.cs |
Added detailed remarks about UIKit integration and example setup code |
AutoSuspendHelper.cs |
Replaced outdated AppDelegate instructions with complete usage example |
ViewModelViewHost.cs |
Added remarks about runtime view resolution and example configuration |
ObservableAsPropertyHelper.cs |
Added example demonstrating derived property pattern |
IViewFor.cs |
Enhanced interface documentation with view activation example |
ISuspensionHost.cs |
Added comprehensive suspension lifecycle example |
IScreen.cs |
Improved documentation with navigation coordinator example |
IRoutableViewModel.cs |
Added example showing proper implementation pattern |
IActivatableViewModel.cs |
Added activation pattern example with WhenActivated usage |
InteractionContext.cs |
Enhanced documentation with handler example |
Interaction.cs |
Added complete view model and view interaction example, fixed grammar |
IInteraction.cs |
Added comprehensive example demonstrating interaction registration |
IReactiveUIBuilder.cs |
Added fluent builder configuration example |
IReactiveBinding.cs |
Added example showing binding lifecycle and Changed observable |
PropertyBindingMixins.cs |
Added common binding patterns example |
InteractionBindingMixins.cs |
Added interaction binding example within activation |
IActivationForViewFetcher.cs |
Added custom platform fetcher implementation example |
|
|
||
| /// <summary> | ||
| /// Gets a interaction context which is used to provide information about the interaction. | ||
| /// Gets an interaction context which is used to provide information about the interaction. |
There was a problem hiding this comment.
The article should be "an" instead of "a" before "interaction" since "interaction" starts with a vowel sound.
Contributor
There was a problem hiding this comment.
@copilot open a new pull request to apply changes based on this feedback
Contributor
There was a problem hiding this comment.
@copilot open a new pull request to apply changes based on this feedback
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
|
@glennawatson I've opened a new pull request, #4234, to work on those changes. Once the pull request is ready, I'll request review from you. |
Contributor
|
@glennawatson I've opened a new pull request, #4235, to work on those changes. Once the pull request is ready, I'll request review from you. |
…error message (#4234) Addresses grammar feedback from #4233 regarding incorrect article usage before words starting with vowel sounds. ## Changes - **UnhandledInteractionException.cs line 28**: Changed "a input handler" → "an input handler" in XML documentation - **UnhandledInteractionException.cs line 31**: Changed "a Interaction" → "an Interaction" in exception message string
…4235) Corrects grammar in error message from "a Interaction" to "an Interaction" since "Interaction" begins with a vowel sound. ## Changes - Updated `UnhandledInteractionException.cs` constructor error message to use correct article ```csharp // Before : this("Failed to find a registration for a Interaction.") // After : this("Failed to find a registration for an Interaction.") ``` Addresses feedback from parent PR #4233. <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/reactiveui/ReactiveUI/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: glennawatson <5834289+glennawatson@users.noreply.github.com>
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.
What kind of change does this PR introduce?
Xml Docs update
What is the new behavior?
Enhanced XML documentation for key ReactiveUI interfaces and classes, including remarks and code examples.
Improves discoverability and developer experience by clarifying usage patterns for activation, routing, interaction, suspension, and view binding APIs.
What might this PR break?
N/A
Please check if the PR fulfills these requirements
Other information: