Skip to content
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

MudTable: Add XML Documentation for Public Members #9189

Merged
merged 30 commits into from
Jun 28, 2024

Conversation

jperson2000
Copy link
Sponsor Contributor

@jperson2000 jperson2000 commented Jun 16, 2024

Description

This update adds XML documentation for MudTable<T> and associated types:

  • EditButtonContext
  • HorizontalAlignment
  • MudTFootRow
  • MudTHeadRow
  • MudTableGroupRow
  • MudTablePager
  • MudTableSortLabel
  • MudTd
  • MudTh
  • MudTr
  • SortDirection
  • TableApplyButtonPosition
  • TableContext
  • TableEditButtonPosition
  • TableEditTrigger
  • TableGroupData
  • TableGroupDefinition
  • TableRowClickEventArgs
  • TableRowHoverEventArgs
  • TableRowValidator
  • TableState

How Has This Been Tested?

This was tested by observing the documentation for MudTable examples:

MudTable

image image image image image image image image image

MudTablePager

image image image

TableGroupDefinition

image

TableState

image image

TableData

image

Type of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (fix or improvement to the website or code docs)

Checklist

  • The PR is submitted to the correct branch (dev).
  • My code follows the code style of this project.
  • I've added relevant tests.

@github-actions github-actions bot added the docs Related to docs label Jun 16, 2024
@jperson2000 jperson2000 self-assigned this Jun 16, 2024
Copy link

codecov bot commented Jun 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.00%. Comparing base (28bc599) to head (3b7e5c9).
Report is 300 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #9189      +/-   ##
==========================================
+ Coverage   89.82%   91.00%   +1.17%     
==========================================
  Files         412      403       -9     
  Lines       11878    12560     +682     
  Branches     2364     2439      +75     
==========================================
+ Hits        10670    11430     +760     
+ Misses        681      594      -87     
- Partials      527      536       +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@igotinfected igotinfected left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@danielchalmers danielchalmers left a comment

Choose a reason for hiding this comment

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

Not that familiar with this component so enjoying how thorough the detail is. I might have missed some things though because of that

src/MudBlazor/Components/Table/MudTable.razor.cs Outdated Show resolved Hide resolved
src/MudBlazor/Components/Table/TableEditTrigger.cs Outdated Show resolved Hide resolved
src/MudBlazor/Enums/SortDirection.cs Outdated Show resolved Hide resolved
src/MudBlazor/Components/Table/MudTable.razor.cs Outdated Show resolved Hide resolved
@jperson2000 jperson2000 marked this pull request as ready for review June 20, 2024 04:50
@jperson2000
Copy link
Sponsor Contributor Author

Alrighty, this is finally ready to review. I can get all PR comments done tomorrow (6/20). Thanks for taking a look!

Copy link

sonarcloud bot commented Jun 22, 2024

@jperson2000
Copy link
Sponsor Contributor Author

I think this is ready to merge but I'll be available if you find any issues. Thanks!

@henon henon merged commit 2558c4e into MudBlazor:dev Jun 28, 2024
4 checks passed
@henon
Copy link
Collaborator

henon commented Jun 28, 2024

Thanks bigtime @jperson2000 and everyone who helped reviewing!

@jperson2000 jperson2000 deleted the feature/mudtable-xmldocumentation branch June 28, 2024 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants