Conversation
Contributor
Reviewer's GuideUpdates XML documentation across filter-related components to use from the IFilterAction interface, ensuring consistent, centralized documentation for Reset, GetFilterConditions, and SetFilterConditionsAsync while preserving existing behavior. Class diagram for filter actions using IFilterAction inheritdocclassDiagram
direction LR
class IFilterAction {
+void Reset()
+FilterKeyValueAction GetFilterConditions()
+Task SetFilterConditionsAsync(FilterKeyValueAction filter)
}
class FilterKeyValueAction {
+string FieldKey
+object FieldValue
+FilterAction FilterAction
}
class FilterAction
class SearchFilterAction {
+string Name
+object Value
+FilterAction Action
+void Reset()
+FilterKeyValueAction GetFilterConditions()
+Task SetFilterConditionsAsync(FilterKeyValueAction filter)
}
class SerializeFilterAction {
+FilterKeyValueAction Filter
+void Reset()
+FilterKeyValueAction GetFilterConditions()
+Task SetFilterConditionsAsync(FilterKeyValueAction filter)
}
class FilterBase {
+void Reset()*
+FilterKeyValueAction GetFilterConditions()*
+Task SetFilterConditionsAsync(FilterKeyValueAction filter)
#Task OnFilterAsync()
}
class BoolFilter {
-string _value
+void Reset()
+FilterKeyValueAction GetFilterConditions()
+Task SetFilterConditionsAsync(FilterKeyValueAction filter)
#void OnParametersSet()
}
class DateTimeFilter {
+DateTimeValueType Value
+IEnumerable~SelectedItem~ Items
+void Reset()
+FilterKeyValueAction GetFilterConditions()
+Task SetFilterConditionsAsync(FilterKeyValueAction filter)
#void OnParametersSet()
}
class NotSupportFilter {
+void Reset()
+FilterKeyValueAction GetFilterConditions()
}
class MultiFilter {
-List~SelectedItem~ _items
-List~SelectedItem~ _source
+void Reset()
+FilterKeyValueAction GetFilterConditions()
+Task SetFilterConditionsAsync(FilterKeyValueAction filter)
}
class EnumFilter {
+void Reset()
+FilterKeyValueAction GetFilterConditions()
+Task SetFilterConditionsAsync(FilterKeyValueAction filter)
}
class LookupFilter {
+void Reset()
+FilterKeyValueAction GetFilterConditions()
+Task SetFilterConditionsAsync(FilterKeyValueAction filter)
#Task OnParametersSetAsync()
}
class MultiSelectFilter_TType_ {
+List~SelectedItem~ Items
+void Reset()
+FilterKeyValueAction GetFilterConditions()
+Task SetFilterConditionsAsync(FilterKeyValueAction filter)
}
class NumberFilter {
+void Reset()
+FilterKeyValueAction GetFilterConditions()
+Task SetFilterConditionsAsync(FilterKeyValueAction filter)
#void OnParametersSet()
}
class StringFilter {
+void Reset()
+FilterKeyValueAction GetFilterConditions()
+Task SetFilterConditionsAsync(FilterKeyValueAction filter)
#void OnParametersSet()
}
IFilterAction <|.. SearchFilterAction
IFilterAction <|.. SerializeFilterAction
IFilterAction <|.. FilterBase
FilterBase <|-- BoolFilter
FilterBase <|-- DateTimeFilter
FilterBase <|-- NotSupportFilter
FilterBase <|-- MultiFilter
FilterBase <|-- EnumFilter
FilterBase <|-- LookupFilter
FilterBase <|-- MultiSelectFilter_TType_
FilterBase <|-- NumberFilter
FilterBase <|-- StringFilter
FilterKeyValueAction --> FilterAction
SearchFilterAction --> FilterKeyValueAction
SerializeFilterAction --> FilterKeyValueAction
BoolFilter --> FilterKeyValueAction
DateTimeFilter --> FilterKeyValueAction
NotSupportFilter --> FilterKeyValueAction
MultiFilter --> FilterKeyValueAction
EnumFilter --> FilterKeyValueAction
LookupFilter --> FilterKeyValueAction
MultiSelectFilter_TType_ --> FilterKeyValueAction
NumberFilter --> FilterKeyValueAction
StringFilter --> FilterKeyValueAction
File-Level Changes
Assessment against linked issues
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7739 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 750 750
Lines 33269 33269
Branches 4612 4612
=========================================
Hits 33269 33269
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Filters components’ XML documentation to consistently inherit from IFilterAction members, aligning method docs across filter implementations and reducing duplicated bilingual summaries.
Changes:
- Replaced repeated method
<summary>text with<inheritdoc cref="IFilterAction.*"/>across filter components and filter-action implementations. - Reordered/normalized some method doc blocks to match the
IFilterActionmember ordering (e.g.,GetFilterConditionsplacement). - Simplified some overridden framework-method docs (e.g.,
OnParametersSet) to use<inheritdoc/>directly.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/BootstrapBlazor/Components/Filters/StringFilter.razor.cs | Use IFilterAction-based cref inheritdoc for Reset/Get/Set conditions. |
| src/BootstrapBlazor/Components/Filters/SerializeFilterAction.cs | Replace duplicated summaries with IFilterAction inheritdoc; reorder GetFilterConditions. |
| src/BootstrapBlazor/Components/Filters/SearchFilterAction.cs | Replace duplicated summaries with IFilterAction inheritdoc; reorder GetFilterConditions. |
| src/BootstrapBlazor/Components/Filters/NumberFilter.razor.cs | Use IFilterAction-based cref inheritdoc for Reset/Get/Set conditions. |
| src/BootstrapBlazor/Components/Filters/NotSupportFilter.razor.cs | Update docs to inherit from IFilterAction for Reset/Get conditions. |
| src/BootstrapBlazor/Components/Filters/MultiSelectFilter.razor.cs | Use IFilterAction-based cref inheritdoc for Reset/Get/Set conditions. |
| src/BootstrapBlazor/Components/Filters/MultiFilter.razor.cs | Replace method summaries with IFilterAction inheritdoc for Reset/Get/Set conditions. |
| src/BootstrapBlazor/Components/Filters/LookupFilter.razor.cs | Use IFilterAction-based cref inheritdoc for Reset/Get/Set conditions. |
| src/BootstrapBlazor/Components/Filters/FilterBase.cs | Replace abstract method summaries with IFilterAction inheritdoc references. |
| src/BootstrapBlazor/Components/Filters/EnumFilter.razor.cs | Use IFilterAction-based cref inheritdoc for Reset/Get/Set conditions. |
| src/BootstrapBlazor/Components/Filters/DateTimeFilter.razor.cs | Simplify inheritdoc usage and point filter action methods to IFilterAction members. |
| src/BootstrapBlazor/Components/Filters/BoolFilter.razor.cs | Simplify inheritdoc usage and point filter action methods to IFilterAction members. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Link issues
fixes #7738
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Align filter component documentation with the IFilterAction interface and clean up inherited XML comments across filter implementations.
Enhancements:
Documentation: