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

Docs: MudDrawer: Added XML Documentation for Public Members #8955

Merged
merged 13 commits into from May 14, 2024

Conversation

jperson2000
Copy link
Sponsor Contributor

Description

This update adds XML documentation for MudDrawer and a few related enumerations:

  • DrawerVariant
  • DrawerClipMode
  • Anchor
  • Breakpoint

This update fixes #1020.

How Has This Been Tested?

This was tested by observing documentation for MudDrawer examples:

image image image image image 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 May 11, 2024
Copy link

codecov bot commented May 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.48%. Comparing base (28bc599) to head (cda787d).
Report is 194 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #8955      +/-   ##
==========================================
+ Coverage   89.82%   90.48%   +0.65%     
==========================================
  Files         412      420       +8     
  Lines       11878    12211     +333     
  Branches     2364     2385      +21     
==========================================
+ Hits        10670    11049     +379     
+ Misses        681      627      -54     
- Partials      527      535       +8     

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

@jperson2000 jperson2000 marked this pull request as ready for review May 11, 2024 22:11
@jperson2000
Copy link
Sponsor Contributor Author

This is ready to review @danielchalmers @ScarletKuro @dclamage when you get time. Thanks!

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.

Thank you!! Just some notes for consistency

src/MudBlazor/Components/Drawer/MudDrawer.razor.cs Outdated Show resolved Hide resolved
src/MudBlazor/Components/Drawer/MudDrawer.razor.cs Outdated Show resolved Hide resolved
src/MudBlazor/Components/Drawer/MudDrawer.razor.cs Outdated Show resolved Hide resolved
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.

This is great because I was going to make some tweaks to the drawer and now I have docs available

@jperson2000 jperson2000 requested a review from Anu6is May 12, 2024 02:24
@jperson2000 jperson2000 requested a review from Anu6is May 12, 2024 02:34
@ScarletKuro ScarletKuro requested a review from henon May 12, 2024 18:31
@henon henon merged commit 3652764 into MudBlazor:dev May 14, 2024
4 checks passed
@henon
Copy link
Collaborator

henon commented May 14, 2024

Thanks!

@jperson2000 jperson2000 deleted the feature/muddrawer-xmldocumentation branch May 14, 2024 14:05
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.

Drawer reference documentation could be improved
5 participants