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

Improve xml comments review 5th DRAFT #12148

Closed

Conversation

paul1956
Copy link
Contributor

@paul1956 paul1956 commented Sep 15, 2024

Addresses improved XML comment in #11984

Proposed changes

  • Add and improve XML comments in VB code

Customer Impact

  • Improve WinForms Design experience

Regression?

  • No

Risk

  • None - no code changes
Microsoft Reviewers: Open in CodeFlow

@paul1956 paul1956 requested a review from a team as a code owner September 15, 2024 23:33
@paul1956 paul1956 changed the title Improve xml comments review 6th draft Improve xml comments review 6th DRAFT Sep 15, 2024
Copy link

codecov bot commented Sep 16, 2024

Codecov Report

Attention: Patch coverage is 90.74794% with 381 lines in your changes missing coverage. Please review.

Project coverage is 76.38745%. Comparing base (776484e) to head (a418a68).

Additional details and impacted files
@@                 Coverage Diff                 @@
##                main      #12148         +/-   ##
===================================================
+ Coverage   76.18249%   76.38745%   +0.20495%     
===================================================
  Files           3194        3202          +8     
  Lines         640365      644094       +3729     
  Branches       47239       47525        +286     
===================================================
+ Hits          487846      492007       +4161     
+ Misses        148983      148540        -443     
- Partials        3536        3547         +11     
Flag Coverage Δ
Debug 76.38745% <90.74794%> (+0.20495%) ⬆️
integration 18.12634% <6.78776%> (-0.03690%) ⬇️
production 50.42534% <74.92850%> (+0.30776%) ⬆️
test 97.01678% <96.15510%> (-0.00319%) ⬇️
unit 47.86140% <69.39943%> (+0.32171%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

@Tanya-Solyanik Tanya-Solyanik added the draft draft PR label Sep 18, 2024
@Tanya-Solyanik Tanya-Solyanik marked this pull request as draft September 18, 2024 01:50
@paul1956 paul1956 changed the title Improve xml comments review 6th DRAFT Improve xml comments review 5th DRAFT Sep 19, 2024
''' <exception cref="NotSupportedException">A folder name in the path contains a colon (:) or is in an invalid format.</exception>
''' <exception cref="SecurityException">The user lacks necessary permissions to view the path.</exception>
''' <exception cref="UnauthorizedAccessException">A destination file exists but cannot be accessed.</exception>
Public Sub CopyDirectory(sourceDirectoryName As String, destinationDirectoryName As String, overwrite As Boolean)
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps this comment can reference docs for the SYstem.IO API via the inheritdocs tag?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Tanya-Solyanik i can fix comment but this is not ready to be reviewed (it should be DRAFT) as it includes all the other small PR’s not yet merged.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Tanya-Solyanik

I have updated the VB Runtime Proxy Comments to use inheritdoc cref=""
Sometimes I could point to System.IO other files I had to point to FileIO.FileSystem because VB is not always a thin layer over System.IO, in some causes Sub and Function are swapped, return types are different or System.IO does not have all the overloads that VB has plus other similar reasons. The complexity/size of the files has been drastically simplified.

This is still not ready to review.

Improve code coverage for upload tests
Support more real File Server  options
…' into Shorten-long-inline-comments-Review-4th
…internal implementation. Use TypeResolver to load SystemConfiguration and add sample configuration for real servers. Add tests for leading ServerConfiguration json files.
…' into Shorten-long-inline-comments-Review-4th
…' into Shorten-long-inline-comments-Review-4th
@paul1956 paul1956 closed this Jan 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
draft draft PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants