doc(Extensions): update extensions method coments#7838
Merged
Conversation
Contributor
Reviewer's GuideRefactors and enriches XML documentation comments for dialog and download-related extension methods, standardizing bilingual (zh/en) parameter docs and clarifying semantics without changing runtime behavior. 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}
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- In
DownloadServiceExtensions.DownloadFromStreamAsync, the<param name="download">documentation is still empty while other overloads now describe it; consider adding a matching bilingual description for consistency. - The updated XML docs for
DirectoryInfoExtensions.Copydropped the detailed<remarks>and<exception>information about directory creation, recursion, and thrown exceptions; if that behavior remains valid, it would be helpful to keep those details in the comments. - In
DirectoryInfoExtensionssummary, the English text "DirectoryInfo extensions method" is slightly ungrammatical; consider changing it to "DirectoryInfo extension methods" or similar for clarity.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In `DownloadServiceExtensions.DownloadFromStreamAsync`, the `<param name="download">` documentation is still empty while other overloads now describe it; consider adding a matching bilingual description for consistency.
- The updated XML docs for `DirectoryInfoExtensions.Copy` dropped the detailed `<remarks>` and `<exception>` information about directory creation, recursion, and thrown exceptions; if that behavior remains valid, it would be helpful to keep those details in the comments.
- In `DirectoryInfoExtensions` summary, the English text "DirectoryInfo extensions method" is slightly ungrammatical; consider changing it to "DirectoryInfo extension methods" or similar for clarity.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates XML documentation comments across several Extensions classes to improve readability and provide clearer bilingual (zh/en) parameter descriptions.
Changes:
- Reformats
<param>XML docs into multi-line blocks with separate zh/en<para>entries. - Adds missing zh/en parameter descriptions for several extension methods.
- Adjusts some English summary text in extension classes.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/BootstrapBlazor/Extensions/DownloadServiceExtensions.cs | Reformats parameter XML docs for download helper methods and expands several param descriptions. |
| src/BootstrapBlazor/Extensions/DirectoryInfoExtensions.cs | Updates summary/param XML docs for DirectoryInfo.Copy and adds zh translations, but reduces previously present behavioral documentation. |
| src/BootstrapBlazor/Extensions/DialogServiceExtensions.cs | Reformats and expands parameter XML docs for multiple DialogService extension methods. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
20
to
+24
| /// <param name="download"></param> | ||
| /// <param name="downloadFileName"><para lang="zh">文件名</para><para lang="en">File name</para></param> | ||
| /// <param name="stream"><para lang="zh">文件流</para><para lang="en">File stream</para></param> | ||
| /// <param name="downloadFileName"> | ||
| /// <para lang="zh">文件名</para> | ||
| /// <para lang="en">File name</para> | ||
| /// </param> |
There was a problem hiding this comment.
The XML doc for this overload still leaves the download parameter description empty, while other methods in this class now document it bilingually. Please add a zh/en description for download here as well for consistency and to avoid incomplete generated docs.
| /// <summary> | ||
| /// <para lang="zh">DirectoryInfo 扩展方法</para> | ||
| /// <para lang="en">DirectoryInfo 扩展方法</para> | ||
| /// <para lang="en">DirectoryInfo extensions method</para> |
There was a problem hiding this comment.
English summary text is grammatically incorrect: "DirectoryInfo extensions method" should be plural and use "extension" (e.g., "DirectoryInfo extension methods").
Suggested change
| /// <para lang="en">DirectoryInfo extensions method</para> | |
| /// <para lang="en">DirectoryInfo extension methods</para> |
Comment on lines
14
to
17
| /// <summary> | ||
| /// <para lang="zh">Copies the 内容s of the current directory to a specified destination directory</para> | ||
| /// <para lang="zh">将当前目录的内容复制到指定的目标目录</para> | ||
| /// <para lang="en">Copies the contents of the current directory to a specified destination directory</para> | ||
| /// </summary> |
There was a problem hiding this comment.
The previous documentation included important behavioral details (destination directory is created if missing, and that a DirectoryNotFoundException is thrown when the source directory doesn’t exist). Those details are no longer documented. Please re-add this information via and an tag (preferably with zh/en content).
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7838 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 764 764
Lines 34165 34165
Branches 4704 4704
=========================================
Hits 34165 34165
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:
|
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 #7837
Summary By Copilot
Regression?
Risk
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Improve and clarify XML documentation comments for dialog and download extension methods.
Enhancements: