Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Nov 29, 2024

update parameter document

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #4755

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

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 the SortableList component documentation to include new parameter descriptions and enhance the Bar chart component by using Random.Shared for random number generation.

Enhancements:

  • Replace usage of a private Random instance with Random.Shared in the Bar chart component for improved performance and consistency.

Documentation:

  • Add documentation for new parameters in the SortableList component, including descriptions for SortableListOption, OnAdd, OnUpdate, and OnRemove attributes.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Nov 29, 2024

Reviewer's Guide by Sourcery

This 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 component

classDiagram
    class SortableList {
        +SortableOption Option
        +Func<SortableEvent, Task> OnAdd
        +Func<SortableEvent, Task> OnUpdate
        +Func<SortableEvent, Task> OnRemove
    }
    note for SortableList "Added attributes for documentation purposes"
Loading

Class diagram for updated Bar chart component

classDiagram
    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"
Loading

File-Level Changes

Change Details Files
Added documentation for SortableList component parameters
  • Added GetAttributes method to provide parameter documentation
  • Added documentation for Option, OnAdd, OnUpdate, and OnRemove parameters
  • Added corresponding localization strings in both English and Chinese
  • Added AttributeTable component to display parameter documentation
src/BootstrapBlazor.Server/Components/Samples/SortableLists.razor.cs
src/BootstrapBlazor.Server/Components/Samples/SortableLists.razor
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Improved random number generation in Bar chart component
  • Replaced Random instance with Random.Shared for better thread safety
  • Removed private Randomer property
  • Updated all random number generation calls to use Random.Shared
src/BootstrapBlazor.Server/Components/Samples/Charts/Bar.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4755 Update sortablejs to version 1.15.6 The PR only updates documentation by adding parameter descriptions for SortableList component. It does not include any version updates to sortablejs.

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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 the enhancement New feature or request label Nov 29, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Nov 29, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) November 29, 2024 04:11
Copy link
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 @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

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.

@codecov
Copy link

codecov bot commented Nov 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (5405bf0) to head (72af4ab).
Report is 1 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

@ArgoZhang ArgoZhang merged commit 44da935 into main Nov 29, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the dev-srotablejs branch November 29, 2024 04:13
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(SortableList): update parameter document

2 participants