Skip to content

doc(Component): update annotation text of components#7465

Merged
ArgoZhang merged 3 commits intomainfrom
doc-misc
Jan 2, 2026
Merged

doc(Component): update annotation text of components#7465
ArgoZhang merged 3 commits intomainfrom
doc-misc

Conversation

@ArgoZhang
Copy link
Copy Markdown
Member

@ArgoZhang ArgoZhang commented Jan 2, 2026

Link issues

fixes #7464

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Update component documentation annotations to correct wording and clarify behavior.

Documentation:

  • Correct the SlideButton placement parameter XML comment to describe the dropdown display position rather than button color.
  • Fix the DateTimeFilter component summary text typo from "DataTime" to "DateTime" and adjust button click event propagation comment text.

Copilot AI review requested due to automatic review settings January 2, 2026 08:29
@bb-auto bb-auto Bot added the documentation Improvements or additions to documentation label Jan 2, 2026
@bb-auto bb-auto Bot added this to the v10.2.0 milestone Jan 2, 2026
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jan 2, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR updates component documentation annotations in both English and Chinese for button-related components and the DateTime filter, correcting terminology and clarifying behavior without changing runtime logic.

File-Level Changes

Change Details Files
Clarify SlideButton placement documentation comment.
  • Update the Chinese XML summary of the Placement parameter to describe it as the display position of expanded items instead of button color
src/BootstrapBlazor/Components/Button/SlideButton.razor.cs
Fix English summary of the DateTimeFilter component.
  • Correct the XML summary text from 'DataTime filter component' to 'DateTime filter component'
src/BootstrapBlazor/Components/Filters/DateTimeFilter.razor.cs
Clarify ButtonBase click event propagation documentation comment.
  • Update the Chinese XML summary of the StopPropagation parameter to refer to click events rather than a typo for 'time'
src/BootstrapBlazor/Components/Button/ButtonBase.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#7464 Update and correct the summary/documentation text for the affected components.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@ArgoZhang ArgoZhang changed the title doc(Component): update summary of components doc(Component): update annotation text of components Jan 2, 2026
@ArgoZhang ArgoZhang enabled auto-merge (squash) January 2, 2026 08:31
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 2, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (03ebf66) to head (3e0cc8e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #7465   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          749       749           
  Lines        32912     32912           
  Branches      4573      4573           
=========================================
  Hits         32912     32912           
Flag Coverage Δ
BB 100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang ArgoZhang disabled auto-merge January 2, 2026 08:35
@ArgoZhang ArgoZhang merged commit d1601d6 into main Jan 2, 2026
9 of 10 checks passed
@ArgoZhang ArgoZhang deleted the doc-misc branch January 2, 2026 08:35
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR addresses issue #7464 by correcting documentation comments in three component files. The changes fix typos and incorrect parameter descriptions in XML summary comments.

Key Changes:

  • Fixed spelling error "DataTime" to "DateTime" in DateTimeFilter component
  • Corrected mismatched documentation for the Placement parameter in SlideButton component
  • Fixed Chinese terminology from "时间" (time) to "事件" (event) in ButtonBase component

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
src/BootstrapBlazor/Components/Filters/DateTimeFilter.razor.cs Corrected spelling of "DateTime" in component summary comment
src/BootstrapBlazor/Components/Button/SlideButton.razor.cs Updated parameter documentation to correctly describe Placement instead of Color
src/BootstrapBlazor/Components/Button/ButtonBase.cs Fixed Chinese terminology in StopPropagation parameter documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc(Component): update summary of components

2 participants