Skip to content

feat(UniverSheet): update xml comments#927

Merged
ArgoZhang merged 2 commits intomasterfrom
feat-univer
Feb 17, 2026
Merged

feat(UniverSheet): update xml comments#927
ArgoZhang merged 2 commits intomasterfrom
feat-univer

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Feb 17, 2026

Link issues

fixes #926

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 UniverSheet component XML documentation to provide bilingual Chinese and English summaries and parameter descriptions, and remove redundant XML tags.

Enhancements:

  • Add Chinese and English XML documentation comments for UniverSheet component properties and JS-invokable methods.
  • Clarify behavior descriptions for configuration parameters such as plugins, theme, dark mode, language, toolbar style, loading mask, and data callbacks.
  • Clean up redundant XML documentation elements like empty tags to improve code readability.

Copilot AI review requested due to automatic review settings February 17, 2026 00:52
@bb-auto bb-auto bot added the enhancement New feature or request label Feb 17, 2026
@sourcery-ai
Copy link

sourcery-ai bot commented Feb 17, 2026

Reviewer's Guide

Updates XML documentation comments for the UniverSheet Blazor component to provide bilingual (Chinese/English) summaries and parameter descriptions, cleans up redundant XML tags, and slightly refines wording for clarity without changing runtime behavior.

File-Level Changes

Change Details Files
Convert UniverSheet XML documentation to bilingual zh/en summaries and property descriptions.
  • Wrap existing Chinese XML doc comments in and add corresponding English text for the UniverSheet class and its public parameters
  • Clarify property descriptions such as theme, dark mode, language, ribbon style, data, loading mask, loading text, data callbacks, and ready callbacks while keeping signatures unchanged
src/components/BootstrapBlazor.UniverSheet/Components/UniverSheet.razor.cs
Clean up XML documentation noise and improve method summaries for JS interop-related methods.
  • Remove empty tags where already documents the return type or where the return value is obvious
  • Add English descriptions for methods like PushDataAsync, TriggerPostData, and TriggerReadyAsync, noting they are called by JavaScript or push data to the sheet
src/components/BootstrapBlazor.UniverSheet/Components/UniverSheet.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#926 Update and improve the XML documentation comments for the UniverSheet component, including its properties and methods.

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

@bb-auto bb-auto bot added this to the v9.2.0 milestone Feb 17, 2026
@ArgoZhang ArgoZhang merged commit b0ce3d7 into master Feb 17, 2026
6 checks passed
@ArgoZhang ArgoZhang deleted the feat-univer branch February 17, 2026 00:52
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

This PR updates XML documentation comments in the UniverSheet component to use a bilingual format, providing both Chinese (zh) and English (en) language versions using para tags. This aligns the UniverSheet component's documentation with the bilingual documentation pattern used in other components like EmbedPDF, Term, and PdfViewer.

Changes:

  • Added bilingual XML comments (Chinese and English) to all public properties and methods in UniverSheet component
  • Removed empty <returns> tags from methods where they don't provide meaningful documentation
  • Fixed a minor typo in Chinese documentation (removed duplicate "设置" on line 46)
  • Added "univer" to the spelling exclusion dictionary

Reviewed changes

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

File Description
src/components/BootstrapBlazor.UniverSheet/Components/UniverSheet.razor.cs Updated all XML comments to bilingual format with Chinese and English para tags, removed empty returns tags, and fixed a minor typo in Chinese documentation
exclusion.dic Added "univer" to the spelling exclusion dictionary

💡 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

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(UniverSheet): update xml comments

2 participants