Skip to content

doc(UniverSheet): update documentation#944

Merged
ArgoZhang merged 2 commits intomasterfrom
doc-xml
Mar 7, 2026
Merged

doc(UniverSheet): update documentation#944
ArgoZhang merged 2 commits intomasterfrom
doc-xml

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Mar 7, 2026

Link issues

fixes #943

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

Documentation:

  • Clarify the UniverSheet OnPostDataAsync parameter description in both Chinese and English to better describe its purpose and typical trigger (Excel button).

Copilot AI review requested due to automatic review settings March 7, 2026 08:54
@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Mar 7, 2026
@bb-auto bb-auto bot added this to the v9.2.0 milestone Mar 7, 2026
@sourcery-ai
Copy link

sourcery-ai bot commented Mar 7, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the UniverSheet component’s XML documentation to better describe the OnPostDataAsync callback, clarifying that it is a UniverSheet data callback typically triggered by an Excel button.

File-Level Changes

Change Details Files
Clarified XML documentation for the UniverSheet data callback parameter OnPostDataAsync.
  • Updated the Chinese XML doc comment to state that the callback is for UniverSheet data and is generally triggered by an Excel button.
  • Updated the English XML doc comment to match, describing it as the UniverSheet data callback method usually triggered by the Excel button.
src/components/BootstrapBlazor.UniverSheet/Components/UniverSheet.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#943 Update the UniverSheet component’s documentation/commentation to accurately describe the relevant callback behavior.

Possibly linked issues


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 merged commit da35f14 into master Mar 7, 2026
3 checks passed
@ArgoZhang ArgoZhang deleted the doc-xml branch March 7, 2026 08:54
Copy link

@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.

Copy link

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

Updates the UniverSheet component’s XML documentation to better describe the OnPostDataAsync callback, as part of the documentation refresh requested in #943.

Changes:

  • Reworded the bilingual <summary> for OnPostDataAsync to describe its purpose/trigger.

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

Comment on lines +74 to +75
/// <para lang="zh">获得/设置 UniverSheet 数据回调方法(一般由 Excel 按钮触发)</para>
/// <para lang="en">Gets or sets the UniverSheet data callback method (usually triggered by the Excel button).</para>
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

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

The updated summary mentions the callback is usually triggered by an “Excel button”, but there’s no corresponding concept in the component/JS (TriggerPostData is invoked via JS interop from wwwroot/data-service.js:getDataAsync). This makes the API documentation misleading for consumers; consider rewording to describe the actual trigger (i.e., invoked when JavaScript calls TriggerPostData / when the sheet requests data from .NET) rather than a specific UI element.

Suggested change
/// <para lang="zh">获得/设置 UniverSheet 数据回调方法(一般由 Excel 按钮触发)</para>
/// <para lang="en">Gets or sets the UniverSheet data callback method (usually triggered by the Excel button).</para>
/// <para lang="zh">获得/设置 UniverSheet 数据回调方法(由前端通过 JavaScript 调用 TriggerPostData 或工作表向 .NET 请求数据时触发)</para>
/// <para lang="en">Gets or sets the UniverSheet data callback method (invoked when JavaScript calls TriggerPostData, i.e., when the sheet requests data from .NET).</para>

Copilot uses AI. Check for mistakes.
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(UniverSheet): update documentation

2 participants