-
-
Notifications
You must be signed in to change notification settings - Fork 364
doc(SortableList): update parameter document #4756
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Reviewer's Guide by SourceryThis PR updates the documentation for the SortableList component by adding parameter descriptions and making improvements to the random number generation in the Bar chart component. The changes include adding attribute documentation for SortableList parameters and replacing Random instance with Random.Shared. Class diagram for updated SortableList componentclassDiagram
class SortableList {
+SortableOption Option
+Func<SortableEvent, Task> OnAdd
+Func<SortableEvent, Task> OnUpdate
+Func<SortableEvent, Task> OnRemove
}
note for SortableList "Added attributes for documentation purposes"
Class diagram for updated Bar chart componentclassDiagram
class Bar {
-Random Randomer
+int _barDatasetCount
+int _barDataCount
+Task<ChartDataSource> OnInit(bool stacked, bool setTitle)
+Task OnReloadChart()
+Task<ChartDataSource> OnInitTwoYAxes(bool stacked, bool setTitle)
+Task<ChartDataSource> OnInitStack(bool stacked)
+Task<ChartDataSource> OnInitAspectRatio(bool stacked)
+Task<ChartDataSource> OnInitShowDataLabel(bool showDataLabel)
+Task<ChartDataSource> OnInitBarColorSeparately(bool barColorSeparately)
}
note for Bar "Replaced Random instance with Random.Shared for random number generation"
File-Level Changes
Assessment against linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @ArgoZhang - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4756 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 620 620
Lines 27390 27390
Branches 3921 3921
=========================================
Hits 27390 27390 ☔ View full report in Codecov by Sentry. |
update parameter document
Summary of the changes (Less than 80 chars)
简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号
Description
fixes #4755
Regression?
[If yes, specify the version the behavior has regressed from]
[是否影响老版本]
Risk
[Justify the selection above]
Verification
Packaging changes reviewed?
☑️ Self Check before Merge
Summary by Sourcery
Update the SortableList component documentation to include new parameter descriptions and enhance the Bar chart component by using Random.Shared for random number generation.
Enhancements:
Documentation: